@microsoft/teams-js 2.1.1-beta.0 → 2.2.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/MicrosoftTeams.d.ts +940 -238
- package/dist/MicrosoftTeams.js +710 -286
- package/dist/MicrosoftTeams.js.map +1 -1
- package/dist/MicrosoftTeams.min.js +1 -1
- package/dist/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -1
package/dist/MicrosoftTeams.d.ts
CHANGED
@@ -5,56 +5,86 @@
|
|
5
5
|
* Namespace to interact with the logging part of the SDK.
|
6
6
|
* This object is used to send the app logs on demand to the host client
|
7
7
|
*
|
8
|
-
* Hide from docs
|
9
|
-
*
|
10
8
|
* @internal
|
9
|
+
* Limited to Microsoft-internal use
|
11
10
|
*/
|
12
11
|
export namespace logs {
|
13
12
|
/**
|
14
13
|
* @hidden
|
15
|
-
*
|
16
|
-
* ------
|
14
|
+
*
|
17
15
|
* Registers a handler for getting app log
|
18
16
|
*
|
19
17
|
* @param handler - The handler to invoke to get the app log
|
18
|
+
*
|
19
|
+
* @internal
|
20
|
+
* Limited to Microsoft-internal use
|
20
21
|
*/
|
21
22
|
function registerGetLogHandler(handler: () => string): void;
|
23
|
+
/**
|
24
|
+
* @hidden
|
25
|
+
*
|
26
|
+
* @returns boolean to represent whether the logs capability is supported
|
27
|
+
*
|
28
|
+
* @internal
|
29
|
+
* Limited to Microsoft-internal use
|
30
|
+
*/
|
22
31
|
function isSupported(): boolean;
|
23
32
|
}
|
24
33
|
|
25
34
|
/**
|
26
35
|
* @hidden
|
27
|
-
*
|
28
|
-
* --------
|
36
|
+
*
|
29
37
|
* Information about all members in a chat
|
38
|
+
*
|
39
|
+
* @internal
|
40
|
+
* Limited to Microsoft-internal use
|
30
41
|
*/
|
31
42
|
export interface ChatMembersInformation {
|
32
43
|
members: ThreadMember[];
|
33
44
|
}
|
34
45
|
/**
|
35
46
|
* @hidden
|
36
|
-
*
|
37
|
-
* --------
|
47
|
+
*
|
38
48
|
* Information about a chat member
|
49
|
+
*
|
50
|
+
* @internal
|
51
|
+
* Limited to Microsoft-internal use
|
39
52
|
*/
|
40
53
|
export interface ThreadMember {
|
41
54
|
/**
|
42
55
|
* @hidden
|
43
56
|
* The member's user principal name in the current tenant.
|
57
|
+
*
|
58
|
+
* @internal
|
59
|
+
* Limited to Microsoft-internal use
|
44
60
|
*/
|
45
61
|
upn: string;
|
46
62
|
}
|
63
|
+
/**
|
64
|
+
* @hidden
|
65
|
+
*
|
66
|
+
* @internal
|
67
|
+
* Limited to Microsoft-internal use
|
68
|
+
*/
|
47
69
|
export enum NotificationTypes {
|
48
70
|
fileDownloadStart = "fileDownloadStart",
|
49
71
|
fileDownloadComplete = "fileDownloadComplete"
|
50
72
|
}
|
73
|
+
/**
|
74
|
+
* @hidden
|
75
|
+
*
|
76
|
+
* @internal
|
77
|
+
* Limited to Microsoft-internal use
|
78
|
+
*/
|
51
79
|
export interface ShowNotificationParameters {
|
52
80
|
message: string;
|
53
81
|
notificationType: NotificationTypes;
|
54
82
|
}
|
55
83
|
/**
|
56
84
|
* @hidden
|
57
|
-
*
|
85
|
+
*
|
86
|
+
* @internal
|
87
|
+
* Limited to Microsoft-internal use
|
58
88
|
*/
|
59
89
|
export enum ViewerActionTypes {
|
60
90
|
view = "view",
|
@@ -63,143 +93,197 @@ export enum ViewerActionTypes {
|
|
63
93
|
}
|
64
94
|
/**
|
65
95
|
* @hidden
|
66
|
-
*
|
67
|
-
* ------
|
96
|
+
*
|
68
97
|
* User setting changes that can be subscribed to
|
69
98
|
*/
|
70
99
|
export enum UserSettingTypes {
|
71
100
|
/**
|
72
101
|
* @hidden
|
73
102
|
* Use this key to subscribe to changes in user's file open preference
|
103
|
+
*
|
104
|
+
* @internal
|
105
|
+
* Limited to Microsoft-internal use
|
74
106
|
*/
|
75
107
|
fileOpenPreference = "fileOpenPreference",
|
76
108
|
/**
|
77
109
|
* @hidden
|
78
110
|
* Use this key to subscribe to theme changes
|
111
|
+
*
|
112
|
+
* @internal
|
113
|
+
* Limited to Microsoft-internal use
|
79
114
|
*/
|
80
115
|
theme = "theme"
|
81
116
|
}
|
82
117
|
/**
|
83
118
|
* @hidden
|
84
|
-
*
|
119
|
+
*
|
120
|
+
* @internal
|
121
|
+
* Limited to Microsoft-internal use
|
85
122
|
*/
|
86
123
|
export interface FilePreviewParameters {
|
87
124
|
/**
|
88
125
|
* @hidden
|
89
126
|
* The developer-defined unique ID for the file.
|
127
|
+
*
|
128
|
+
* @internal
|
129
|
+
* Limited to Microsoft-internal use
|
90
130
|
*/
|
91
131
|
entityId: string;
|
92
132
|
/**
|
93
133
|
* @hidden
|
94
134
|
* The display name of the file.
|
135
|
+
*
|
136
|
+
* @internal
|
137
|
+
* Limited to Microsoft-internal use
|
95
138
|
*/
|
96
139
|
title: string;
|
97
140
|
/**
|
98
141
|
* @hidden
|
99
142
|
* An optional description of the file.
|
143
|
+
*
|
144
|
+
* @internal
|
145
|
+
* Limited to Microsoft-internal use
|
100
146
|
*/
|
101
147
|
description?: string;
|
102
148
|
/**
|
103
149
|
* @hidden
|
104
150
|
* The file extension; e.g. pptx, docx, etc.
|
151
|
+
*
|
152
|
+
* @internal
|
153
|
+
* Limited to Microsoft-internal use
|
105
154
|
*/
|
106
155
|
type: string;
|
107
156
|
/**
|
108
157
|
* @hidden
|
109
158
|
* A url to the source of the file, used to open the content in the user's default browser
|
159
|
+
*
|
160
|
+
* @internal
|
161
|
+
* Limited to Microsoft-internal use
|
110
162
|
*/
|
111
163
|
objectUrl: string;
|
112
164
|
/**
|
113
165
|
* @hidden
|
114
166
|
* Optional; an alternate self-authenticating url used to preview the file in Mobile clients and offer it for download by the user
|
167
|
+
*
|
168
|
+
* @internal
|
169
|
+
* Limited to Microsoft-internal use
|
115
170
|
*/
|
116
171
|
downloadUrl?: string;
|
117
172
|
/**
|
118
173
|
* @hidden
|
119
174
|
* Optional; an alternate url optimized for previewing the file in web and desktop clients
|
175
|
+
*
|
176
|
+
* @internal
|
177
|
+
* Limited to Microsoft-internal use
|
120
178
|
*/
|
121
179
|
webPreviewUrl?: string;
|
122
180
|
/**
|
123
181
|
* @hidden
|
124
182
|
* Optional; an alternate url that allows editing of the file in web and desktop clients
|
183
|
+
*
|
184
|
+
* @internal
|
185
|
+
* Limited to Microsoft-internal use
|
125
186
|
*/
|
126
187
|
webEditUrl?: string;
|
127
188
|
/**
|
128
189
|
* @hidden
|
129
190
|
* Optional; the base url of the site where the file is hosted
|
191
|
+
*
|
192
|
+
* @internal
|
193
|
+
* Limited to Microsoft-internal use
|
130
194
|
*/
|
131
195
|
baseUrl?: string;
|
132
196
|
/**
|
133
197
|
* @hidden
|
134
|
-
* Deprecated; prefer using viewerAction instead
|
198
|
+
* Deprecated; prefer using {@linkcode viewerAction} instead
|
135
199
|
* Optional; indicates whether the file should be opened in edit mode
|
200
|
+
*
|
201
|
+
* @internal
|
202
|
+
* Limited to Microsoft-internal use
|
136
203
|
*/
|
137
204
|
editFile?: boolean;
|
138
205
|
/**
|
139
206
|
* @hidden
|
140
207
|
* Optional; the developer-defined unique ID for the sub-entity to return to when the file stage closes.
|
141
208
|
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
|
209
|
+
*
|
210
|
+
* @internal
|
211
|
+
* Limited to Microsoft-internal use
|
142
212
|
*/
|
143
213
|
subEntityId?: string;
|
144
214
|
/**
|
145
215
|
* @hidden
|
146
216
|
* Optional; indicates the mode in which file should be opened. Takes precedence over edit mode.
|
217
|
+
*
|
218
|
+
* @internal
|
219
|
+
* Limited to Microsoft-internal use
|
147
220
|
*/
|
148
221
|
viewerAction?: ViewerActionTypes;
|
149
222
|
/**
|
150
223
|
* @hidden
|
151
224
|
* Optional; indicates how user prefers to open the file
|
225
|
+
*
|
226
|
+
* @internal
|
227
|
+
* Limited to Microsoft-internal use
|
152
228
|
*/
|
153
229
|
fileOpenPreference?: FileOpenPreference;
|
154
230
|
/**
|
231
|
+
* @hidden
|
155
232
|
* Optional; id required to enable conversation button in files. Will be channel id in case file is shared in a channel or the chat id in p2p chat case.
|
233
|
+
*
|
234
|
+
* @internal
|
235
|
+
* Limited to Microsoft-internal use
|
156
236
|
*/
|
157
237
|
conversationId?: string;
|
158
238
|
}
|
159
239
|
/**
|
160
240
|
* @hidden
|
161
|
-
*
|
162
|
-
* --------
|
241
|
+
*
|
163
242
|
* Query parameters used when fetching team information
|
243
|
+
*
|
244
|
+
* @internal
|
245
|
+
* Limited to Microsoft-internal use
|
164
246
|
*/
|
165
247
|
export interface TeamInstanceParameters {
|
166
248
|
/**
|
167
249
|
* @hidden
|
168
250
|
* Flag allowing to select favorite teams only
|
251
|
+
*
|
252
|
+
* @internal
|
253
|
+
* Limited to Microsoft-internal use
|
169
254
|
*/
|
170
255
|
favoriteTeamsOnly?: boolean;
|
171
256
|
}
|
172
257
|
/**
|
173
258
|
* @hidden
|
174
|
-
*
|
175
|
-
* --------
|
259
|
+
*
|
176
260
|
* Information on userJoined Teams
|
261
|
+
*
|
262
|
+
* @internal
|
263
|
+
* Limited to Microsoft-internal use
|
177
264
|
*/
|
178
265
|
export interface UserJoinedTeamsInformation {
|
179
266
|
/**
|
180
267
|
* @hidden
|
181
268
|
* List of team information
|
269
|
+
*
|
270
|
+
* @internal
|
271
|
+
* Limited to Microsoft-internal use
|
182
272
|
*/
|
183
273
|
userJoinedTeams: TeamInformation[];
|
184
274
|
}
|
185
275
|
|
186
|
-
/**
|
187
|
-
* @internal
|
188
|
-
*/
|
189
|
-
export function initializePrivateApis(): void;
|
190
276
|
/**
|
191
277
|
* @hidden
|
192
|
-
* Hide from docs.
|
193
|
-
* ------
|
194
278
|
* Upload a custom App manifest directly to both team and personal scopes.
|
195
279
|
* This method works just for the first party Apps.
|
196
280
|
*
|
197
281
|
* @internal
|
282
|
+
* Limited to Microsoft-internal use
|
198
283
|
*/
|
199
284
|
export function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void): void;
|
200
285
|
/**
|
201
286
|
* @hidden
|
202
|
-
* Internal use only
|
203
287
|
* Sends a custom action MessageRequest to host or parent window
|
204
288
|
*
|
205
289
|
* @param actionName - Specifies name of the custom action to be sent
|
@@ -208,11 +292,11 @@ export function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolea
|
|
208
292
|
* @returns id of sent message
|
209
293
|
*
|
210
294
|
* @internal
|
295
|
+
* Limited to Microsoft-internal use
|
211
296
|
*/
|
212
297
|
export function sendCustomMessage(actionName: string, args?: any[], callback?: (...args: any[]) => void): void;
|
213
298
|
/**
|
214
299
|
* @hidden
|
215
|
-
* Internal use only
|
216
300
|
* Sends a custom action MessageEvent to a child iframe/window, only if you are not using auth popup.
|
217
301
|
* Otherwise it will go to the auth popup (which becomes the child)
|
218
302
|
*
|
@@ -221,17 +305,18 @@ export function sendCustomMessage(actionName: string, args?: any[], callback?: (
|
|
221
305
|
* @returns id of sent message
|
222
306
|
*
|
223
307
|
* @internal
|
308
|
+
* Limited to Microsoft-internal use
|
224
309
|
*/
|
225
310
|
export function sendCustomEvent(actionName: string, args?: any[]): void;
|
226
311
|
/**
|
227
312
|
* @hidden
|
228
|
-
* Internal use only
|
229
313
|
* Adds a handler for an action sent by a child window or parent window
|
230
314
|
*
|
231
315
|
* @param actionName - Specifies name of the action message to handle
|
232
316
|
* @param customHandler - The callback to invoke when the action message is received. The return value is sent to the child
|
233
317
|
*
|
234
318
|
* @internal
|
319
|
+
* Limited to Microsoft-internal use
|
235
320
|
*/
|
236
321
|
export function registerCustomHandler(actionName: string, customHandler: (...args: any[]) => any[]): void;
|
237
322
|
/**
|
@@ -242,94 +327,129 @@ export function registerCustomHandler(actionName: string, customHandler: (...arg
|
|
242
327
|
* @param handler - When a subscribed setting is updated this handler is called
|
243
328
|
*
|
244
329
|
* @internal
|
330
|
+
* Limited to Microsoft-internal use
|
245
331
|
*/
|
246
332
|
export function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
|
247
333
|
/**
|
248
334
|
* @hidden
|
249
|
-
* Hide from docs.
|
250
|
-
* ------
|
251
335
|
* Opens a client-friendly preview of the specified file.
|
252
336
|
*
|
253
337
|
* @param file - The file to preview.
|
338
|
+
*
|
339
|
+
* @internal
|
340
|
+
* Limited to Microsoft-internal use
|
254
341
|
*/
|
255
342
|
export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
|
256
343
|
|
257
344
|
/**
|
258
345
|
* @hidden
|
259
|
-
* Hide from docs.
|
260
|
-
* ------
|
261
346
|
*
|
262
347
|
* @internal
|
348
|
+
* Limited to Microsoft-internal use
|
263
349
|
*/
|
264
350
|
export interface OpenConversationRequest {
|
265
351
|
/**
|
266
352
|
* @hidden
|
267
353
|
* The Id of the subEntity where the conversation is taking place
|
354
|
+
*
|
355
|
+
* @internal
|
356
|
+
* Limited to Microsoft-internal use
|
268
357
|
*/
|
269
358
|
subEntityId: string;
|
270
359
|
/**
|
271
360
|
* @hidden
|
272
361
|
* The title of the conversation
|
362
|
+
*
|
363
|
+
* @internal
|
364
|
+
* Limited to Microsoft-internal use
|
273
365
|
*/
|
274
366
|
title: string;
|
275
367
|
/**
|
276
368
|
* @hidden
|
277
369
|
* The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
|
370
|
+
*
|
371
|
+
* @internal
|
372
|
+
* Limited to Microsoft-internal use
|
278
373
|
*/
|
279
374
|
conversationId?: string;
|
280
375
|
/**
|
281
376
|
* @hidden
|
282
377
|
* The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
|
378
|
+
*
|
379
|
+
* @internal
|
380
|
+
* Limited to Microsoft-internal use
|
283
381
|
*/
|
284
382
|
channelId?: string;
|
285
383
|
/**
|
286
384
|
* @hidden
|
287
385
|
* The entity Id of the tab
|
386
|
+
*
|
387
|
+
* @internal
|
388
|
+
* Limited to Microsoft-internal use
|
288
389
|
*/
|
289
390
|
entityId: string;
|
290
391
|
/**
|
291
392
|
* @hidden
|
292
393
|
* A function that is called once the conversation Id has been created
|
394
|
+
*
|
395
|
+
* @internal
|
396
|
+
* Limited to Microsoft-internal use
|
293
397
|
*/
|
294
398
|
onStartConversation?: (conversationResponse: ConversationResponse) => void;
|
295
399
|
/**
|
296
400
|
* @hidden
|
297
401
|
* A function that is called if the pane is closed
|
402
|
+
*
|
403
|
+
* @internal
|
404
|
+
* Limited to Microsoft-internal use
|
298
405
|
*/
|
299
406
|
onCloseConversation?: (conversationResponse: ConversationResponse) => void;
|
300
407
|
}
|
301
408
|
/**
|
302
409
|
* @hidden
|
303
|
-
* Hide from docs.
|
304
|
-
* ------
|
305
410
|
*
|
306
411
|
* @internal
|
412
|
+
* Limited to Microsoft-internal use
|
307
413
|
*/
|
308
414
|
export interface ConversationResponse {
|
309
415
|
/**
|
310
416
|
* @hidden
|
417
|
+
*
|
418
|
+
* Limited to Microsoft-internal use
|
311
419
|
* The Id of the subEntity where the conversation is taking place
|
312
420
|
*/
|
313
421
|
subEntityId: string;
|
314
422
|
/**
|
315
423
|
* @hidden
|
316
424
|
* The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
|
425
|
+
*
|
426
|
+
* @internal
|
427
|
+
* Limited to Microsoft-internal use
|
317
428
|
*/
|
318
429
|
conversationId?: string;
|
319
430
|
/**
|
320
431
|
* @hidden
|
321
432
|
* The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
|
433
|
+
*
|
434
|
+
* @internal
|
435
|
+
* Limited to Microsoft-internal use
|
322
436
|
*/
|
323
437
|
channelId?: string;
|
324
438
|
/**
|
325
439
|
* @hidden
|
326
440
|
* The entity Id of the tab
|
441
|
+
*
|
442
|
+
* @internal
|
443
|
+
* Limited to Microsoft-internal use
|
327
444
|
*/
|
328
445
|
entityId?: string;
|
329
446
|
}
|
330
447
|
/**
|
331
448
|
* @hidden
|
332
449
|
* Namespace to interact with the conversational subEntities inside the tab
|
450
|
+
*
|
451
|
+
* @internal
|
452
|
+
* Limited to Microsoft-internal use
|
333
453
|
*/
|
334
454
|
export namespace conversations {
|
335
455
|
/**
|
@@ -339,13 +459,18 @@ export namespace conversations {
|
|
339
459
|
* Allows the user to start or continue a conversation with each subentity inside the tab
|
340
460
|
*
|
341
461
|
* @returns Promise resolved upon completion
|
462
|
+
*
|
463
|
+
* @internal
|
464
|
+
* Limited to Microsoft-internal use
|
342
465
|
*/
|
343
466
|
function openConversation(openConversationRequest: OpenConversationRequest): Promise<void>;
|
344
467
|
/**
|
345
468
|
* @hidden
|
346
|
-
*
|
347
|
-
* --------------
|
469
|
+
*
|
348
470
|
* Allows the user to close the conversation in the right pane
|
471
|
+
*
|
472
|
+
* @internal
|
473
|
+
* Limited to Microsoft-internal use
|
349
474
|
*/
|
350
475
|
function closeConversation(): void;
|
351
476
|
/**
|
@@ -359,23 +484,34 @@ export namespace conversations {
|
|
359
484
|
* @returns Promise resolved with information on all chat members
|
360
485
|
*
|
361
486
|
* @internal
|
487
|
+
* Limited to Microsoft-internal use
|
362
488
|
*/
|
363
489
|
function getChatMembers(): Promise<ChatMembersInformation>;
|
490
|
+
/**
|
491
|
+
* @returns boolean to represent whether conversations capability is supported
|
492
|
+
*
|
493
|
+
* @internal
|
494
|
+
* Limited to Microsoft-internal use
|
495
|
+
*/
|
364
496
|
function isSupported(): boolean;
|
365
497
|
}
|
366
498
|
|
367
499
|
/**
|
368
500
|
* @hidden
|
369
|
-
*
|
370
|
-
* ------
|
501
|
+
*
|
371
502
|
* Namespace to interact with the files specific part of the SDK.
|
503
|
+
*
|
504
|
+
* @internal
|
505
|
+
* Limited to Microsoft-internal use
|
372
506
|
*/
|
373
507
|
export namespace files {
|
374
508
|
/**
|
375
509
|
* @hidden
|
376
|
-
*
|
377
|
-
* ------
|
510
|
+
*
|
378
511
|
* Cloud storage providers registered with Microsoft Teams
|
512
|
+
*
|
513
|
+
* @internal
|
514
|
+
* Limited to Microsoft-internal use
|
379
515
|
*/
|
380
516
|
export enum CloudStorageProvider {
|
381
517
|
Dropbox = "DROPBOX",
|
@@ -396,10 +532,11 @@ export namespace files {
|
|
396
532
|
}
|
397
533
|
/**
|
398
534
|
* @hidden
|
399
|
-
* Hide from docs
|
400
|
-
* ------
|
401
535
|
*
|
402
536
|
* External third-party cloud storages providers interface
|
537
|
+
*
|
538
|
+
* @internal
|
539
|
+
* Limited to Microsoft-internal use
|
403
540
|
*/
|
404
541
|
export interface IExternalProvider extends IWopiService {
|
405
542
|
providerType: CloudStorageProviderType;
|
@@ -407,9 +544,11 @@ export namespace files {
|
|
407
544
|
}
|
408
545
|
/**
|
409
546
|
* @hidden
|
410
|
-
* Hide from docs
|
411
547
|
*
|
412
548
|
* Cloud storage provider type enums
|
549
|
+
*
|
550
|
+
* @internal
|
551
|
+
* Limited to Microsoft-internal use
|
413
552
|
*/
|
414
553
|
export enum CloudStorageProviderType {
|
415
554
|
Sharepoint = 0,
|
@@ -425,155 +564,231 @@ export namespace files {
|
|
425
564
|
}
|
426
565
|
/**
|
427
566
|
* @hidden
|
428
|
-
* Hide from docs
|
429
|
-
* ------
|
430
567
|
*
|
431
568
|
* Cloud storage folder interface
|
569
|
+
*
|
570
|
+
* @internal
|
571
|
+
* Limited to Microsoft-internal use
|
432
572
|
*/
|
433
573
|
export interface CloudStorageFolder {
|
434
574
|
/**
|
435
575
|
* @hidden
|
436
576
|
* ID of the cloud storage folder
|
577
|
+
*
|
578
|
+
* @internal
|
579
|
+
* Limited to Microsoft-internal use
|
437
580
|
*/
|
438
581
|
id: string;
|
439
582
|
/**
|
440
583
|
* @hidden
|
441
584
|
* Display Name/Title of the cloud storage folder
|
585
|
+
*
|
586
|
+
* @internal
|
587
|
+
* Limited to Microsoft-internal use
|
442
588
|
*/
|
443
589
|
title: string;
|
444
590
|
/**
|
445
591
|
* @hidden
|
446
592
|
* ID of the cloud storage folder in the provider
|
593
|
+
*
|
594
|
+
* @internal
|
595
|
+
* Limited to Microsoft-internal use
|
447
596
|
*/
|
448
597
|
folderId: string;
|
449
598
|
/**
|
450
599
|
* @hidden
|
451
600
|
* Type of the cloud storage folder provider integration
|
601
|
+
*
|
602
|
+
* @internal
|
603
|
+
* Limited to Microsoft-internal use
|
452
604
|
*/
|
453
605
|
providerType: CloudStorageProviderType;
|
454
606
|
/**
|
455
607
|
* @hidden
|
456
608
|
* Code of the supported cloud storage folder provider
|
609
|
+
*
|
610
|
+
* @internal
|
611
|
+
* Limited to Microsoft-internal use
|
457
612
|
*/
|
458
613
|
providerCode: CloudStorageProvider;
|
459
614
|
/**
|
460
615
|
* @hidden
|
461
616
|
* Display name of the owner of the cloud storage folder provider
|
617
|
+
*
|
618
|
+
* @internal
|
619
|
+
* Limited to Microsoft-internal use
|
462
620
|
*/
|
463
621
|
ownerDisplayName: string;
|
464
622
|
/**
|
465
623
|
* @hidden
|
466
624
|
* Sharepoint specific siteURL of the folder
|
625
|
+
*
|
626
|
+
* @internal
|
627
|
+
* Limited to Microsoft-internal use
|
467
628
|
*/
|
468
629
|
siteUrl?: string;
|
469
630
|
/**
|
470
631
|
* @hidden
|
471
632
|
* Sharepoint specific serverRelativeUrl of the folder
|
633
|
+
*
|
634
|
+
* @internal
|
635
|
+
* Limited to Microsoft-internal use
|
472
636
|
*/
|
473
637
|
serverRelativeUrl?: string;
|
474
638
|
/**
|
475
639
|
* @hidden
|
476
640
|
* Sharepoint specific libraryType of the folder
|
641
|
+
*
|
642
|
+
* @internal
|
643
|
+
* Limited to Microsoft-internal use
|
477
644
|
*/
|
478
645
|
libraryType?: string;
|
479
646
|
/**
|
480
647
|
* @hidden
|
481
648
|
* Sharepoint specific accessType of the folder
|
649
|
+
*
|
650
|
+
* @internal
|
651
|
+
* Limited to Microsoft-internal use
|
482
652
|
*/
|
483
653
|
accessType?: string;
|
484
654
|
}
|
485
655
|
/**
|
486
656
|
* @hidden
|
487
|
-
* Hide from docs
|
488
|
-
* ------
|
489
657
|
*
|
490
658
|
* Cloud storage item interface
|
659
|
+
*
|
660
|
+
* @internal
|
661
|
+
* Limited to Microsoft-internal use
|
491
662
|
*/
|
492
663
|
export interface CloudStorageFolderItem {
|
493
664
|
/**
|
494
665
|
* @hidden
|
495
666
|
* ID of the item in the provider
|
667
|
+
*
|
668
|
+
* @internal
|
669
|
+
* Limited to Microsoft-internal use
|
496
670
|
*/
|
497
671
|
id: string;
|
498
672
|
/**
|
499
673
|
* @hidden
|
500
674
|
* Display name/title
|
675
|
+
*
|
676
|
+
* @internal
|
677
|
+
* Limited to Microsoft-internal use
|
501
678
|
*/
|
502
679
|
title: string;
|
503
680
|
/**
|
504
681
|
* @hidden
|
505
682
|
* Key to differentiate files and subdirectory
|
683
|
+
*
|
684
|
+
* @internal
|
685
|
+
* Limited to Microsoft-internal use
|
506
686
|
*/
|
507
687
|
isSubdirectory: boolean;
|
508
688
|
/**
|
509
689
|
* @hidden
|
510
690
|
* File extension
|
691
|
+
*
|
692
|
+
* @internal
|
693
|
+
* Limited to Microsoft-internal use
|
511
694
|
*/
|
512
695
|
type: string;
|
513
696
|
/**
|
514
697
|
* @hidden
|
515
698
|
* Last modifed time of the item
|
699
|
+
*
|
700
|
+
* @internal
|
701
|
+
* Limited to Microsoft-internal use
|
516
702
|
*/
|
517
703
|
lastModifiedTime: string;
|
518
704
|
/**
|
519
705
|
* @hidden
|
520
706
|
* Display size of the items in bytes
|
707
|
+
*
|
708
|
+
* @internal
|
709
|
+
* Limited to Microsoft-internal use
|
521
710
|
*/
|
522
711
|
size: number;
|
523
712
|
/**
|
524
713
|
* @hidden
|
525
714
|
* URL of the file
|
715
|
+
*
|
716
|
+
* @internal
|
717
|
+
* Limited to Microsoft-internal use
|
526
718
|
*/
|
527
719
|
objectUrl: string;
|
528
720
|
/**
|
529
721
|
* @hidden
|
530
722
|
* Temporary access token for the item
|
723
|
+
*
|
724
|
+
* @internal
|
725
|
+
* Limited to Microsoft-internal use
|
531
726
|
*/
|
532
727
|
accessToken?: string;
|
533
728
|
}
|
534
729
|
/**
|
535
730
|
* @hidden
|
536
|
-
* Hide from docs
|
537
731
|
*
|
538
732
|
* Files entity user interface
|
733
|
+
*
|
734
|
+
* @internal
|
735
|
+
* Limited to Microsoft-internal use
|
539
736
|
*/
|
540
737
|
export interface IFilesEntityUser {
|
541
738
|
/**
|
739
|
+
* @hidden
|
542
740
|
* User name.
|
741
|
+
*
|
742
|
+
* @internal
|
743
|
+
* Limited to Microsoft-internal use
|
543
744
|
*/
|
544
745
|
displayName: string;
|
545
746
|
/**
|
747
|
+
* @hidden
|
546
748
|
* User email.
|
749
|
+
*
|
750
|
+
* @internal
|
751
|
+
* Limited to Microsoft-internal use
|
547
752
|
*/
|
548
753
|
email: string;
|
549
754
|
/**
|
755
|
+
* @hidden
|
550
756
|
* User MRI.
|
757
|
+
*
|
758
|
+
* @internal
|
759
|
+
* Limited to Microsoft-internal use
|
551
760
|
*/
|
552
761
|
mri: string;
|
553
762
|
}
|
554
763
|
/**
|
555
764
|
* @hidden
|
556
|
-
* Hide from docs
|
557
765
|
*
|
558
766
|
* Special Document Library enum
|
767
|
+
*
|
768
|
+
* @internal
|
769
|
+
* Limited to Microsoft-internal use
|
559
770
|
*/
|
560
771
|
export enum SpecialDocumentLibraryType {
|
561
772
|
ClassMaterials = "classMaterials"
|
562
773
|
}
|
563
774
|
/**
|
564
775
|
* @hidden
|
565
|
-
* Hide from docs
|
566
776
|
*
|
567
777
|
* Document Library Access enum
|
778
|
+
*
|
779
|
+
* @internal
|
780
|
+
* Limited to Microsoft-internal use
|
568
781
|
*/
|
569
782
|
export enum DocumentLibraryAccessType {
|
570
783
|
Readonly = "readonly"
|
571
784
|
}
|
572
785
|
/**
|
573
786
|
* @hidden
|
574
|
-
* Hide from docs
|
575
787
|
*
|
576
788
|
* SharePoint file interface
|
789
|
+
*
|
790
|
+
* @internal
|
791
|
+
* Limited to Microsoft-internal use
|
577
792
|
*/
|
578
793
|
export interface ISharePointFile {
|
579
794
|
siteId?: string;
|
@@ -600,9 +815,11 @@ export namespace files {
|
|
600
815
|
}
|
601
816
|
/**
|
602
817
|
* @hidden
|
603
|
-
* Hide from docs
|
604
818
|
*
|
605
819
|
* Download status enum
|
820
|
+
*
|
821
|
+
* @internal
|
822
|
+
* Limited to Microsoft-internal use
|
606
823
|
*/
|
607
824
|
export enum FileDownloadStatus {
|
608
825
|
Downloaded = "Downloaded",
|
@@ -611,45 +828,99 @@ export namespace files {
|
|
611
828
|
}
|
612
829
|
/**
|
613
830
|
* @hidden
|
614
|
-
* Hide from docs
|
615
831
|
*
|
616
832
|
* Download Files interface
|
833
|
+
*
|
834
|
+
* @internal
|
835
|
+
* Limited to Microsoft-internal use
|
617
836
|
*/
|
618
837
|
export interface IFileItem {
|
619
838
|
/**
|
839
|
+
* @hidden
|
620
840
|
* ID of the file metadata
|
841
|
+
*
|
842
|
+
* @internal
|
843
|
+
* Limited to Microsoft-internal use
|
621
844
|
*/
|
622
845
|
objectId?: string;
|
623
846
|
/**
|
847
|
+
* @hidden
|
624
848
|
* Path of the file
|
849
|
+
*
|
850
|
+
* @internal
|
851
|
+
* Limited to Microsoft-internal use
|
625
852
|
*/
|
626
853
|
path?: string;
|
627
854
|
/**
|
855
|
+
* @hidden
|
628
856
|
* Size of the file in bytes
|
857
|
+
*
|
858
|
+
* @internal
|
859
|
+
* Limited to Microsoft-internal use
|
629
860
|
*/
|
630
861
|
sizeInBytes?: number;
|
631
862
|
/**
|
863
|
+
* @hidden
|
632
864
|
* Download status
|
865
|
+
*
|
866
|
+
* @internal
|
867
|
+
* Limited to Microsoft-internal use
|
633
868
|
*/
|
634
869
|
status?: FileDownloadStatus;
|
635
870
|
/**
|
871
|
+
* @hidden
|
636
872
|
* Download timestamp
|
873
|
+
*
|
874
|
+
* @internal
|
875
|
+
* Limited to Microsoft-internal use
|
637
876
|
*/
|
638
877
|
timestamp: Date;
|
639
878
|
/**
|
879
|
+
* @hidden
|
640
880
|
* File name
|
881
|
+
*
|
882
|
+
* @internal
|
883
|
+
* Limited to Microsoft-internal use
|
641
884
|
*/
|
642
885
|
title: string;
|
643
886
|
/**
|
887
|
+
* @hidden
|
644
888
|
* Type of file i.e. the file extension.
|
889
|
+
*
|
890
|
+
* @internal
|
891
|
+
* Limited to Microsoft-internal use
|
645
892
|
*/
|
646
893
|
extension: string;
|
647
894
|
}
|
895
|
+
/**
|
896
|
+
* @hidden
|
897
|
+
* Object used to represent a file
|
898
|
+
*
|
899
|
+
* @internal
|
900
|
+
* Limited to Microsoft-internal use
|
901
|
+
*/
|
902
|
+
export interface File extends Blob {
|
903
|
+
/**
|
904
|
+
* Last modified timestamp
|
905
|
+
*/
|
906
|
+
lastModified: Date;
|
907
|
+
/**
|
908
|
+
* Name of the file
|
909
|
+
*/
|
910
|
+
name: string;
|
911
|
+
/**
|
912
|
+
* The file path to uniquely identify it within the file hierarchy
|
913
|
+
*/
|
914
|
+
filePath: string;
|
915
|
+
}
|
648
916
|
/**
|
649
917
|
* @hidden
|
650
918
|
* Hide from docs
|
651
919
|
*
|
652
920
|
* Actions specific to 3P cloud storage provider file and / or account
|
921
|
+
*
|
922
|
+
* @internal
|
923
|
+
* Limited to Microsoft-internal use
|
653
924
|
*/
|
654
925
|
export enum CloudStorageProviderFileAction {
|
655
926
|
Download = "DOWNLOAD",
|
@@ -661,6 +932,9 @@ export namespace files {
|
|
661
932
|
* Hide from docs
|
662
933
|
*
|
663
934
|
* Interface for 3P cloud storage provider request content type
|
935
|
+
*
|
936
|
+
* @internal
|
937
|
+
* Limited to Microsoft-internal use
|
664
938
|
*/
|
665
939
|
export interface CloudStorageProviderRequest<T> {
|
666
940
|
content: T;
|
@@ -670,6 +944,9 @@ export namespace files {
|
|
670
944
|
* Hide from docs
|
671
945
|
*
|
672
946
|
* Base interface for 3P cloud storage provider action request content
|
947
|
+
*
|
948
|
+
* @internal
|
949
|
+
* Limited to Microsoft-internal use
|
673
950
|
*/
|
674
951
|
export interface CloudStorageProviderContent {
|
675
952
|
providerCode: CloudStorageProvider;
|
@@ -680,16 +957,23 @@ export namespace files {
|
|
680
957
|
*
|
681
958
|
* Interface representing 3P cloud storage provider add new file action.
|
682
959
|
* The file extension represents type of file e.g. docx, pptx etc. and need not be prefixed with dot(.)
|
960
|
+
*
|
961
|
+
* @internal
|
962
|
+
* Limited to Microsoft-internal use
|
683
963
|
*/
|
684
964
|
export interface CloudStorageProviderNewFileContent extends CloudStorageProviderContent {
|
685
965
|
newFileName: string;
|
686
966
|
newFileExtension: string;
|
967
|
+
destinationFolder: CloudStorageFolderItem | ISharePointFile;
|
687
968
|
}
|
688
969
|
/**
|
689
970
|
* @hidden
|
690
971
|
* Hide from docs
|
691
972
|
*
|
692
973
|
* Interface representing 3P cloud storage provider rename existing file action
|
974
|
+
*
|
975
|
+
* @internal
|
976
|
+
* Limited to Microsoft-internal use
|
693
977
|
*/
|
694
978
|
export interface CloudStorageProviderRenameFileContent extends CloudStorageProviderContent {
|
695
979
|
existingFile: CloudStorageFolderItem | ISharePointFile;
|
@@ -699,12 +983,39 @@ export namespace files {
|
|
699
983
|
* @hidden
|
700
984
|
* Hide from docs
|
701
985
|
*
|
702
|
-
* Interface representing 3P cloud storage provider
|
986
|
+
* Interface representing 3P cloud storage provider delete existing file(s) action
|
987
|
+
*
|
988
|
+
* @internal
|
989
|
+
* Limited to Microsoft-internal use
|
703
990
|
*/
|
704
|
-
export interface
|
705
|
-
action: CloudStorageProviderFileAction;
|
991
|
+
export interface CloudStorageProviderDeleteFileContent extends CloudStorageProviderContent {
|
706
992
|
itemList: CloudStorageFolderItem[] | ISharePointFile[];
|
707
993
|
}
|
994
|
+
/**
|
995
|
+
* @hidden
|
996
|
+
* Hide from docs
|
997
|
+
*
|
998
|
+
* Interface representing 3P cloud storage provider download existing file(s) action
|
999
|
+
*
|
1000
|
+
* @internal
|
1001
|
+
* Limited to Microsoft-internal use
|
1002
|
+
*/
|
1003
|
+
export interface CloudStorageProviderDownloadFileContent extends CloudStorageProviderContent {
|
1004
|
+
itemList: CloudStorageFolderItem[] | ISharePointFile[];
|
1005
|
+
}
|
1006
|
+
/**
|
1007
|
+
* @hidden
|
1008
|
+
* Hide from docs
|
1009
|
+
*
|
1010
|
+
* Interface representing 3P cloud storage provider upload existing file(s) action
|
1011
|
+
*
|
1012
|
+
* @internal
|
1013
|
+
* Limited to Microsoft-internal use
|
1014
|
+
*/
|
1015
|
+
export interface CloudStorageProviderUploadFileContent extends CloudStorageProviderContent {
|
1016
|
+
itemList: File[];
|
1017
|
+
destinationFolder: CloudStorageFolderItem | ISharePointFile;
|
1018
|
+
}
|
708
1019
|
/**
|
709
1020
|
* @hidden
|
710
1021
|
* Hide from docs
|
@@ -712,6 +1023,9 @@ export namespace files {
|
|
712
1023
|
* Gets a list of cloud storage folders added to the channel
|
713
1024
|
* @param channelId - ID of the channel whose cloud storage folders should be retrieved
|
714
1025
|
* @param callback - Callback that will be triggered post folders load
|
1026
|
+
*
|
1027
|
+
* @internal
|
1028
|
+
* Limited to Microsoft-internal use
|
715
1029
|
*/
|
716
1030
|
export function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
|
717
1031
|
/**
|
@@ -722,6 +1036,9 @@ export namespace files {
|
|
722
1036
|
*
|
723
1037
|
* @param channelId - ID of the channel to add cloud storage folder
|
724
1038
|
* @param callback - Callback that will be triggered post add folder flow is compelete
|
1039
|
+
*
|
1040
|
+
* @internal
|
1041
|
+
* Limited to Microsoft-internal use
|
725
1042
|
*/
|
726
1043
|
export function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
|
727
1044
|
/**
|
@@ -734,6 +1051,9 @@ export namespace files {
|
|
734
1051
|
* @param channelId - ID of the channel where folder is to be deleted
|
735
1052
|
* @param folderToDelete - cloud storage folder to be deleted
|
736
1053
|
* @param callback - Callback that will be triggered post delete
|
1054
|
+
*
|
1055
|
+
* @internal
|
1056
|
+
* Limited to Microsoft-internal use
|
737
1057
|
*/
|
738
1058
|
export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
|
739
1059
|
/**
|
@@ -746,6 +1066,9 @@ export namespace files {
|
|
746
1066
|
* @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
|
747
1067
|
* @param providerCode - Code of the cloud storage folder provider
|
748
1068
|
* @param callback - Callback that will be triggered post contents are loaded
|
1069
|
+
*
|
1070
|
+
* @internal
|
1071
|
+
* Limited to Microsoft-internal use
|
749
1072
|
*/
|
750
1073
|
export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
|
751
1074
|
/**
|
@@ -758,6 +1081,9 @@ export namespace files {
|
|
758
1081
|
* @param file - cloud storage file that should be opened
|
759
1082
|
* @param providerCode - Code of the cloud storage folder provider
|
760
1083
|
* @param fileOpenPreference - Whether file should be opened in web/inline
|
1084
|
+
*
|
1085
|
+
* @internal
|
1086
|
+
* Limited to Microsoft-internal use
|
761
1087
|
*/
|
762
1088
|
export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
|
763
1089
|
/**
|
@@ -766,12 +1092,18 @@ export namespace files {
|
|
766
1092
|
* third party cloud storage accounts that the tenant supports
|
767
1093
|
* @param excludeAddedProviders: return a list of support third party
|
768
1094
|
* cloud storages that hasn't been added yet.
|
1095
|
+
*
|
1096
|
+
* @internal
|
1097
|
+
* Limited to Microsoft-internal use
|
769
1098
|
*/
|
770
1099
|
export function getExternalProviders(excludeAddedProviders: boolean, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
|
771
1100
|
/**
|
772
1101
|
* @hidden
|
773
1102
|
* Allow 1st party apps to call this function to move files
|
774
1103
|
* among SharePoint and third party cloud storages.
|
1104
|
+
*
|
1105
|
+
* @internal
|
1106
|
+
* Limited to Microsoft-internal use
|
775
1107
|
*/
|
776
1108
|
export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean, callback: (error?: SdkError) => void): void;
|
777
1109
|
/**
|
@@ -781,6 +1113,9 @@ export namespace files {
|
|
781
1113
|
*
|
782
1114
|
* Gets list of downloads for current user
|
783
1115
|
* @param callback Callback that will be triggered post downloads load
|
1116
|
+
*
|
1117
|
+
* @internal
|
1118
|
+
* Limited to Microsoft-internal use
|
784
1119
|
*/
|
785
1120
|
export function getFileDownloads(callback: (error?: SdkError, files?: IFileItem[]) => void): void;
|
786
1121
|
/**
|
@@ -790,6 +1125,9 @@ export namespace files {
|
|
790
1125
|
* Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
|
791
1126
|
* @param fileObjectId - Id of the file whose containing folder should be opened
|
792
1127
|
* @param callback Callback that will be triggered post open download folder/path
|
1128
|
+
*
|
1129
|
+
* @internal
|
1130
|
+
* Limited to Microsoft-internal use
|
793
1131
|
*/
|
794
1132
|
export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;
|
795
1133
|
/**
|
@@ -801,6 +1139,9 @@ export namespace files {
|
|
801
1139
|
* for selected 3P provider is performed on success of which the selected 3P provider support is added for user
|
802
1140
|
*
|
803
1141
|
* @param callback Callback that will be triggered post add 3P cloud storage provider action
|
1142
|
+
*
|
1143
|
+
* @internal
|
1144
|
+
* Limited to Microsoft-internal use
|
804
1145
|
*/
|
805
1146
|
export function addCloudStorageProvider(callback: (error?: SdkError) => void): void;
|
806
1147
|
/**
|
@@ -813,6 +1154,9 @@ export namespace files {
|
|
813
1154
|
*
|
814
1155
|
* @param logoutRequest 3P cloud storage provider remove action request content
|
815
1156
|
* @param callback Callback that will be triggered post signout of 3P cloud storage provider action
|
1157
|
+
*
|
1158
|
+
* @internal
|
1159
|
+
* Limited to Microsoft-internal use
|
816
1160
|
*/
|
817
1161
|
export function removeCloudStorageProvider(logoutRequest: CloudStorageProviderRequest<CloudStorageProviderContent>, callback: (error?: SdkError) => void): void;
|
818
1162
|
/**
|
@@ -823,8 +1167,11 @@ export namespace files {
|
|
823
1167
|
*
|
824
1168
|
* @param addNewFileRequest 3P cloud storage provider add action request content
|
825
1169
|
* @param callback Callback that will be triggered post adding a new file flow is finished
|
1170
|
+
*
|
1171
|
+
* @internal
|
1172
|
+
* Limited to Microsoft-internal use
|
826
1173
|
*/
|
827
|
-
export function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError) => void): void;
|
1174
|
+
export function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
|
828
1175
|
/**
|
829
1176
|
* @hidden
|
830
1177
|
* Hide from docs
|
@@ -833,22 +1180,52 @@ export namespace files {
|
|
833
1180
|
*
|
834
1181
|
* @param renameFileRequest 3P cloud storage provider rename action request content
|
835
1182
|
* @param callback Callback that will be triggered post renaming an existing file flow is finished
|
1183
|
+
*
|
1184
|
+
* @internal
|
1185
|
+
* Limited to Microsoft-internal use
|
1186
|
+
*/
|
1187
|
+
export function renameCloudStorageProviderFile(renameFileRequest: CloudStorageProviderRequest<CloudStorageProviderRenameFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
|
1188
|
+
/**
|
1189
|
+
* @hidden
|
1190
|
+
* Hide from docs
|
1191
|
+
*
|
1192
|
+
* Initiates the delete 3P cloud storage file(s) / folder (folder has to be empty) flow,
|
1193
|
+
* which will delete existing file(s) / folder from the given 3P provider
|
1194
|
+
*
|
1195
|
+
* @param deleteFileRequest 3P cloud storage provider delete action request content
|
1196
|
+
* @param callback Callback that will be triggered post deleting existing file(s) flow is finished
|
1197
|
+
*
|
1198
|
+
* @internal
|
1199
|
+
* Limited to Microsoft-internal use
|
836
1200
|
*/
|
837
|
-
export function
|
1201
|
+
export function deleteCloudStorageProviderFile(deleteFileRequest: CloudStorageProviderRequest<CloudStorageProviderDeleteFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
|
838
1202
|
/**
|
839
1203
|
* @hidden
|
840
1204
|
* Hide from docs
|
841
1205
|
*
|
842
|
-
* Initiates the 3P cloud storage
|
1206
|
+
* Initiates the download 3P cloud storage file(s) flow,
|
1207
|
+
* which will download existing file(s) from the given 3P provider in the teams client side without sharing any file info in the callback
|
843
1208
|
*
|
844
|
-
*
|
845
|
-
*
|
846
|
-
* Delete Action : Allows deleting file(s) from the given 3P cloud storage provider
|
1209
|
+
* @param downloadFileRequest 3P cloud storage provider download file(s) action request content
|
1210
|
+
* @param callback Callback that will be triggered post downloading existing file(s) flow is finished
|
847
1211
|
*
|
848
|
-
* @
|
849
|
-
*
|
1212
|
+
* @internal
|
1213
|
+
* Limited to Microsoft-internal use
|
850
1214
|
*/
|
851
|
-
export function
|
1215
|
+
export function downloadCloudStorageProviderFile(downloadFileRequest: CloudStorageProviderRequest<CloudStorageProviderDownloadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
|
1216
|
+
/**
|
1217
|
+
* @hidden
|
1218
|
+
* Hide from docs
|
1219
|
+
*
|
1220
|
+
* Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
|
1221
|
+
*
|
1222
|
+
* @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
|
1223
|
+
* @param callback Callback that will be triggered post uploading file(s) flow is finished
|
1224
|
+
*
|
1225
|
+
* @internal
|
1226
|
+
* Limited to Microsoft-internal use
|
1227
|
+
*/
|
1228
|
+
export function uploadCloudStorageProviderFile(uploadFileRequest: CloudStorageProviderRequest<CloudStorageProviderUploadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
|
852
1229
|
/**
|
853
1230
|
* @hidden
|
854
1231
|
* Hide from docs
|
@@ -858,6 +1235,7 @@ export namespace files {
|
|
858
1235
|
*
|
859
1236
|
* @param handler - When 3P cloud storage provider list is updated this handler is called
|
860
1237
|
*
|
1238
|
+
* @internal Limited to Microsoft-internal use
|
861
1239
|
*/
|
862
1240
|
export function registerCloudStorageProviderListChangeHandler(handler: () => void): void;
|
863
1241
|
/**
|
@@ -869,151 +1247,194 @@ export namespace files {
|
|
869
1247
|
*
|
870
1248
|
* @param handler - When 3P cloud storage provider content is updated this handler is called
|
871
1249
|
*
|
1250
|
+
* @internal
|
1251
|
+
* Limited to Microsoft-internal use
|
872
1252
|
*/
|
873
1253
|
export function registerCloudStorageProviderContentChangeHandler(handler: () => void): void;
|
874
1254
|
export {};
|
875
1255
|
}
|
876
1256
|
|
1257
|
+
/**
|
1258
|
+
* @hidden
|
1259
|
+
*
|
1260
|
+
* @internal
|
1261
|
+
* Limited to Microsoft-internal use
|
1262
|
+
*/
|
877
1263
|
export namespace meetingRoom {
|
878
1264
|
/**
|
879
1265
|
* @hidden
|
880
|
-
*
|
881
|
-
* ------
|
1266
|
+
*
|
882
1267
|
* Data structure to represent a meeting room.
|
1268
|
+
*
|
1269
|
+
* @internal
|
1270
|
+
* Limited to Microsoft-internal use
|
883
1271
|
*/
|
884
1272
|
export interface MeetingRoomInfo {
|
885
1273
|
/**
|
886
1274
|
* @hidden
|
887
1275
|
* Endpoint id of the meeting room.
|
1276
|
+
*
|
1277
|
+
* @internal
|
1278
|
+
* Limited to Microsoft-internal use
|
888
1279
|
*/
|
889
1280
|
endpointId: string;
|
890
1281
|
/**
|
891
1282
|
* @hidden
|
892
1283
|
* Device name of the meeting room.
|
1284
|
+
*
|
1285
|
+
* @internal
|
1286
|
+
* Limited to Microsoft-internal use
|
893
1287
|
*/
|
894
1288
|
deviceName: string;
|
895
1289
|
/**
|
896
1290
|
* @hidden
|
897
1291
|
* Client type of the meeting room.
|
1292
|
+
*
|
1293
|
+
* @internal
|
1294
|
+
* Limited to Microsoft-internal use
|
898
1295
|
*/
|
899
1296
|
clientType: string;
|
900
1297
|
/**
|
901
1298
|
* @hidden
|
902
1299
|
* Client version of the meeting room.
|
1300
|
+
*
|
1301
|
+
* @internal
|
1302
|
+
* Limited to Microsoft-internal use
|
903
1303
|
*/
|
904
1304
|
clientVersion: string;
|
905
1305
|
}
|
906
1306
|
/**
|
907
1307
|
* @hidden
|
908
|
-
* Hide from docs
|
909
|
-
* ------
|
910
1308
|
* Type of Media control capabilities of a meeting room.
|
911
1309
|
*/
|
912
1310
|
type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
|
913
1311
|
/**
|
914
1312
|
* @hidden
|
915
|
-
* Hide from docs
|
916
|
-
* ------
|
917
1313
|
* Types of Stage Layout control capabilities of a meeting room.
|
918
1314
|
*/
|
919
1315
|
type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
|
920
1316
|
/**
|
921
1317
|
* @hidden
|
922
|
-
* Hide from docs
|
923
|
-
* ------
|
924
1318
|
* Types of Meeting Control capabilities of a meeting room.
|
925
1319
|
*/
|
926
1320
|
type MeetingControls = 'leaveMeeting';
|
927
1321
|
/**
|
928
1322
|
* @hidden
|
929
|
-
* Hide from docs
|
930
|
-
* ------
|
931
1323
|
* Types of Stage Layout State of a meeting room.
|
932
1324
|
*/
|
933
1325
|
type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
|
934
1326
|
/**
|
935
1327
|
* @hidden
|
936
|
-
* Hide from docs
|
937
|
-
* ------
|
938
1328
|
* Data structure to represent capabilities of a meeting room.
|
1329
|
+
*
|
1330
|
+
* @internal
|
1331
|
+
* Limited to Microsoft-internal use
|
939
1332
|
*/
|
940
1333
|
export interface MeetingRoomCapability {
|
941
1334
|
/**
|
942
1335
|
* @hidden
|
943
1336
|
* Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
|
1337
|
+
*
|
1338
|
+
* @internal
|
1339
|
+
* Limited to Microsoft-internal use
|
944
1340
|
*/
|
945
1341
|
mediaControls: MediaControls[];
|
946
1342
|
/**
|
947
1343
|
* @hidden
|
948
1344
|
* Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
|
1345
|
+
*
|
1346
|
+
* @internal
|
1347
|
+
* Limited to Microsoft-internal use
|
949
1348
|
*/
|
950
1349
|
stageLayoutControls: StageLayoutControls[];
|
951
1350
|
/**
|
952
1351
|
* @hidden
|
953
1352
|
* Meeting control capabilities, value can be "leaveMeeting".
|
1353
|
+
*
|
1354
|
+
* @internal
|
1355
|
+
* Limited to Microsoft-internal use
|
954
1356
|
*/
|
955
1357
|
meetingControls: MeetingControls[];
|
956
1358
|
}
|
957
1359
|
/**
|
958
1360
|
* @hidden
|
959
|
-
* Hide from docs
|
960
|
-
* ------
|
961
1361
|
* Data structure to represent states of a meeting room.
|
1362
|
+
*
|
1363
|
+
* @internal
|
1364
|
+
* Limited to Microsoft-internal use
|
962
1365
|
*/
|
963
1366
|
export interface MeetingRoomState {
|
964
1367
|
/**
|
965
1368
|
* @hidden
|
966
1369
|
* Current mute state, true: mute, false: unmute.
|
1370
|
+
*
|
1371
|
+
* @internal
|
1372
|
+
* Limited to Microsoft-internal use
|
967
1373
|
*/
|
968
1374
|
toggleMute: boolean;
|
969
1375
|
/**
|
970
1376
|
* @hidden
|
971
1377
|
* Current camera state, true: camera on, false: camera off.
|
1378
|
+
*
|
1379
|
+
* @internal
|
1380
|
+
* Limited to Microsoft-internal use
|
972
1381
|
*/
|
973
1382
|
toggleCamera: boolean;
|
974
1383
|
/**
|
975
1384
|
* @hidden
|
976
1385
|
* Current captions state, true: captions on, false: captions off.
|
1386
|
+
*
|
1387
|
+
* @internal
|
1388
|
+
* Limited to Microsoft-internal use
|
977
1389
|
*/
|
978
1390
|
toggleCaptions: boolean;
|
979
1391
|
/**
|
980
1392
|
* @hidden
|
981
1393
|
* Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
|
1394
|
+
*
|
1395
|
+
* @internal
|
1396
|
+
* Limited to Microsoft-internal use
|
982
1397
|
*/
|
983
1398
|
stageLayout: StageLayoutStates;
|
984
1399
|
/**
|
985
1400
|
* @hidden
|
986
1401
|
* Current leaveMeeting state, true: leave, false: no-op.
|
1402
|
+
*
|
1403
|
+
* @internal
|
1404
|
+
* Limited to Microsoft-internal use
|
987
1405
|
*/
|
988
1406
|
leaveMeeting: boolean;
|
989
1407
|
}
|
990
1408
|
/**
|
991
1409
|
* @hidden
|
992
|
-
* Hide from docs
|
993
|
-
* ------
|
994
1410
|
* Fetch the meeting room info that paired with current client.
|
995
1411
|
*
|
996
1412
|
* @returns Promise resolved with meeting room info or rejected with SdkError value
|
1413
|
+
*
|
1414
|
+
* @internal
|
1415
|
+
* Limited to Microsoft-internal use
|
997
1416
|
*/
|
998
1417
|
export function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
|
999
1418
|
/**
|
1000
1419
|
* @hidden
|
1001
|
-
* Hide from docs
|
1002
|
-
* ------
|
1003
1420
|
* Send a command to paired meeting room.
|
1004
1421
|
*
|
1005
1422
|
* @param commandName The command name.
|
1006
1423
|
* @returns Promise resolved upon completion or rejected with SdkError value
|
1424
|
+
*
|
1425
|
+
* @internal
|
1426
|
+
* Limited to Microsoft-internal use
|
1007
1427
|
*/
|
1008
1428
|
export function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
|
1009
1429
|
/**
|
1010
1430
|
* @hidden
|
1011
|
-
* Hide from docs
|
1012
|
-
* ------
|
1013
1431
|
* Registers a handler for meeting room capabilities update.
|
1014
1432
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
1015
1433
|
*
|
1016
1434
|
* @param handler The handler to invoke when the capabilities of meeting room update.
|
1435
|
+
*
|
1436
|
+
* @internal
|
1437
|
+
* Limited to Microsoft-internal use
|
1017
1438
|
*/
|
1018
1439
|
export function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
|
1019
1440
|
/**
|
@@ -1023,57 +1444,91 @@ export namespace meetingRoom {
|
|
1023
1444
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
1024
1445
|
*
|
1025
1446
|
* @param handler The handler to invoke when the states of meeting room update.
|
1447
|
+
*
|
1448
|
+
* @internal
|
1449
|
+
* Limited to Microsoft-internal use
|
1026
1450
|
*/
|
1027
1451
|
export function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
|
1452
|
+
/**
|
1453
|
+
* @hidden
|
1454
|
+
*
|
1455
|
+
* @returns boolean to represent whether the meetingRoom capability is supported
|
1456
|
+
*
|
1457
|
+
* @internal
|
1458
|
+
* Limited to Microsoft-internal use
|
1459
|
+
*/
|
1028
1460
|
export function isSupported(): boolean;
|
1029
1461
|
export {};
|
1030
1462
|
}
|
1031
1463
|
|
1032
1464
|
export namespace notifications {
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1039
|
-
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
|
1044
|
-
|
1045
|
-
|
1465
|
+
/**
|
1466
|
+
* @hidden
|
1467
|
+
* display notification API.
|
1468
|
+
*
|
1469
|
+
* @param message - Notification message.
|
1470
|
+
* @param notificationType - Notification type
|
1471
|
+
*
|
1472
|
+
* @internal
|
1473
|
+
* Limited to Microsoft-internal use
|
1474
|
+
*/
|
1475
|
+
function showNotification(showNotificationParameters: ShowNotificationParameters): void;
|
1476
|
+
/**
|
1477
|
+
* @hidden
|
1478
|
+
* @returns boolean to represent whether the notifications capability is supported
|
1479
|
+
*
|
1480
|
+
* @internal
|
1481
|
+
* Limited to Microsoft-internal use
|
1482
|
+
*/
|
1483
|
+
function isSupported(): boolean;
|
1046
1484
|
}
|
1047
1485
|
|
1486
|
+
/**
|
1487
|
+
* @hidden
|
1488
|
+
*
|
1489
|
+
* @internal
|
1490
|
+
* Limited to Microsoft-internal use
|
1491
|
+
*/
|
1048
1492
|
export namespace remoteCamera {
|
1049
1493
|
/**
|
1050
1494
|
* @hidden
|
1051
|
-
* Hide from docs
|
1052
|
-
* ------
|
1053
1495
|
* Data structure to represent patricipant details needed to request control of camera.
|
1496
|
+
*
|
1497
|
+
* @internal
|
1498
|
+
* Limited to Microsoft-internal use
|
1054
1499
|
*/
|
1055
1500
|
interface Participant {
|
1056
1501
|
/**
|
1057
1502
|
* @hidden
|
1058
1503
|
* Id of participant.
|
1504
|
+
*
|
1505
|
+
* @internal
|
1506
|
+
* Limited to Microsoft-internal use
|
1059
1507
|
*/
|
1060
1508
|
id: string;
|
1061
1509
|
/**
|
1062
1510
|
* @hidden
|
1063
1511
|
* Display name of participant.
|
1512
|
+
*
|
1513
|
+
* @internal
|
1514
|
+
* Limited to Microsoft-internal use
|
1064
1515
|
*/
|
1065
1516
|
displayName?: string;
|
1066
1517
|
/**
|
1067
1518
|
* @hidden
|
1068
1519
|
* Active indicates whether the participant's device is actively being controlled.
|
1520
|
+
*
|
1521
|
+
* @internal
|
1522
|
+
* Limited to Microsoft-internal use
|
1069
1523
|
*/
|
1070
1524
|
active?: boolean;
|
1071
1525
|
}
|
1072
1526
|
/**
|
1073
1527
|
* @hidden
|
1074
|
-
* Hide from docs
|
1075
|
-
* ------
|
1076
1528
|
* Enum used to indicate possible camera control commands.
|
1529
|
+
*
|
1530
|
+
* @internal
|
1531
|
+
* Limited to Microsoft-internal use
|
1077
1532
|
*/
|
1078
1533
|
enum ControlCommand {
|
1079
1534
|
Reset = "Reset",
|
@@ -1086,62 +1541,90 @@ export namespace remoteCamera {
|
|
1086
1541
|
}
|
1087
1542
|
/**
|
1088
1543
|
* @hidden
|
1089
|
-
* Hide from docs
|
1090
|
-
* ------
|
1091
1544
|
* Data structure to indicate the current state of the device.
|
1545
|
+
*
|
1546
|
+
* @internal
|
1547
|
+
* Limited to Microsoft-internal use
|
1092
1548
|
*/
|
1093
1549
|
interface DeviceState {
|
1094
1550
|
/**
|
1095
1551
|
* @hidden
|
1096
1552
|
* All operation are available to apply.
|
1553
|
+
*
|
1554
|
+
* @internal
|
1555
|
+
* Limited to Microsoft-internal use
|
1097
1556
|
*/
|
1098
1557
|
available: boolean;
|
1099
1558
|
/**
|
1100
1559
|
* @hidden
|
1101
1560
|
* Either camera doesnt support to get state or It unable to apply command.
|
1561
|
+
*
|
1562
|
+
* @internal
|
1563
|
+
* Limited to Microsoft-internal use
|
1102
1564
|
*/
|
1103
1565
|
error: boolean;
|
1104
1566
|
/**
|
1105
1567
|
* @hidden
|
1106
1568
|
* Reset max out or already applied. Client Disable Reset.
|
1569
|
+
*
|
1570
|
+
* @internal
|
1571
|
+
* Limited to Microsoft-internal use
|
1107
1572
|
*/
|
1108
1573
|
reset: boolean;
|
1109
1574
|
/**
|
1110
1575
|
* @hidden
|
1111
1576
|
* ZoomIn maxed out.
|
1577
|
+
*
|
1578
|
+
* @internal
|
1579
|
+
* Limited to Microsoft-internal use
|
1112
1580
|
*/
|
1113
1581
|
zoomIn: boolean;
|
1114
1582
|
/**
|
1115
1583
|
* @hidden
|
1116
1584
|
* ZoomOut maxed out.
|
1585
|
+
*
|
1586
|
+
* @internal
|
1587
|
+
* Limited to Microsoft-internal use
|
1117
1588
|
*/
|
1118
1589
|
zoomOut: boolean;
|
1119
1590
|
/**
|
1120
1591
|
* @hidden
|
1121
1592
|
* PanLeft reached max left.
|
1593
|
+
*
|
1594
|
+
* @internal
|
1595
|
+
* Limited to Microsoft-internal use
|
1122
1596
|
*/
|
1123
1597
|
panLeft: boolean;
|
1124
1598
|
/**
|
1125
1599
|
* @hidden
|
1126
1600
|
* PanRight reached max right.
|
1601
|
+
*
|
1602
|
+
* @internal
|
1603
|
+
* Limited to Microsoft-internal use
|
1127
1604
|
*/
|
1128
1605
|
panRight: boolean;
|
1129
1606
|
/**
|
1130
1607
|
* @hidden
|
1131
1608
|
* TiltUp reached top.
|
1609
|
+
*
|
1610
|
+
* @internal
|
1611
|
+
* Limited to Microsoft-internal use
|
1132
1612
|
*/
|
1133
1613
|
tiltUp: boolean;
|
1134
1614
|
/**
|
1135
1615
|
* @hidden
|
1136
1616
|
* TiltDown reached bottom.
|
1617
|
+
*
|
1618
|
+
* @internal Limited to Microsoft-internal use
|
1137
1619
|
*/
|
1138
1620
|
tiltDown: boolean;
|
1139
1621
|
}
|
1140
1622
|
/**
|
1141
1623
|
* @hidden
|
1142
|
-
* Hide from docs
|
1143
|
-
* ------
|
1144
1624
|
* Enum used to indicate the reason for the error.
|
1625
|
+
*
|
1626
|
+
* @internal
|
1627
|
+
* Limited to Microsoft-internal use
|
1145
1628
|
*/
|
1146
1629
|
enum ErrorReason {
|
1147
1630
|
CommandResetError = 0,
|
@@ -1155,27 +1638,35 @@ export namespace remoteCamera {
|
|
1155
1638
|
}
|
1156
1639
|
/**
|
1157
1640
|
* @hidden
|
1158
|
-
* Hide from docs
|
1159
|
-
* ------
|
1160
1641
|
* Data structure to indicate the status of the current session.
|
1642
|
+
*
|
1643
|
+
* @internal
|
1644
|
+
* Limited to Microsoft-internal use
|
1161
1645
|
*/
|
1162
1646
|
interface SessionStatus {
|
1163
1647
|
/**
|
1164
1648
|
* @hidden
|
1165
1649
|
* Whether the far-end user is controlling a device.
|
1650
|
+
*
|
1651
|
+
* @internal
|
1652
|
+
* Limited to Microsoft-internal use
|
1166
1653
|
*/
|
1167
1654
|
inControl: boolean;
|
1168
1655
|
/**
|
1169
1656
|
* @hidden
|
1170
1657
|
* Reason the control session was terminated.
|
1658
|
+
*
|
1659
|
+
* @internal
|
1660
|
+
* Limited to Microsoft-internal use
|
1171
1661
|
*/
|
1172
1662
|
terminatedReason?: SessionTerminatedReason;
|
1173
1663
|
}
|
1174
1664
|
/**
|
1175
1665
|
* @hidden
|
1176
|
-
* Hide from docs
|
1177
|
-
* ------
|
1178
1666
|
* Enum used to indicate the reason the session was terminated.
|
1667
|
+
*
|
1668
|
+
* @internal
|
1669
|
+
* Limited to Microsoft-internal use
|
1179
1670
|
*/
|
1180
1671
|
enum SessionTerminatedReason {
|
1181
1672
|
None = 0,
|
@@ -1192,20 +1683,19 @@ export namespace remoteCamera {
|
|
1192
1683
|
}
|
1193
1684
|
/**
|
1194
1685
|
* @hidden
|
1195
|
-
* Hide from docs
|
1196
|
-
* ------
|
1197
1686
|
* Fetch a list of the participants with controllable-cameras in a meeting.
|
1198
1687
|
*
|
1199
1688
|
* @param callback - Callback contains 2 parameters, error and participants.
|
1200
1689
|
* error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
|
1201
1690
|
* participants can either contain an array of Participant objects, incase of a successful fetch or null when it fails
|
1202
1691
|
* participants: object that contains an array of participants with controllable-cameras
|
1692
|
+
*
|
1693
|
+
* @internal
|
1694
|
+
* Limited to Microsoft-internal use
|
1203
1695
|
*/
|
1204
1696
|
function getCapableParticipants(callback: (error: SdkError | null, participants: Participant[] | null) => void): void;
|
1205
1697
|
/**
|
1206
1698
|
* @hidden
|
1207
|
-
* Hide from docs
|
1208
|
-
* ------
|
1209
1699
|
* Request control of a participant's camera.
|
1210
1700
|
*
|
1211
1701
|
* @param participant - Participant specifies the participant to send the request for camera control.
|
@@ -1213,25 +1703,30 @@ export namespace remoteCamera {
|
|
1213
1703
|
* error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
|
1214
1704
|
* requestResponse can either contain the true/false value, incase of a successful request or null when it fails
|
1215
1705
|
* requestResponse: True means request was accepted and false means request was denied
|
1706
|
+
*
|
1707
|
+
* @internal
|
1708
|
+
* Limited to Microsoft-internal use
|
1216
1709
|
*/
|
1217
1710
|
function requestControl(participant: Participant, callback: (error: SdkError | null, requestResponse: boolean | null) => void): void;
|
1218
1711
|
/**
|
1219
1712
|
* @hidden
|
1220
|
-
* Hide from docs
|
1221
|
-
* ------
|
1222
1713
|
* Send control command to the participant's camera.
|
1223
1714
|
*
|
1224
1715
|
* @param ControlCommand - ControlCommand specifies the command for controling the camera.
|
1225
1716
|
* @param callback - Callback to invoke when the command response returns.
|
1717
|
+
*
|
1718
|
+
* @internal
|
1719
|
+
* Limited to Microsoft-internal use
|
1226
1720
|
*/
|
1227
1721
|
function sendControlCommand(ControlCommand: ControlCommand, callback: (error: SdkError | null) => void): void;
|
1228
1722
|
/**
|
1229
1723
|
* @hidden
|
1230
|
-
* Hide from docs
|
1231
|
-
* ------
|
1232
1724
|
* Terminate the remote session
|
1233
1725
|
*
|
1234
1726
|
* @param callback - Callback to invoke when the command response returns.
|
1727
|
+
*
|
1728
|
+
* @internal
|
1729
|
+
* Limited to Microsoft-internal use
|
1235
1730
|
*/
|
1236
1731
|
function terminateSession(callback: (error: SdkError | null) => void): void;
|
1237
1732
|
/**
|
@@ -1240,6 +1735,9 @@ export namespace remoteCamera {
|
|
1240
1735
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
1241
1736
|
*
|
1242
1737
|
* @param handler - The handler to invoke when the list of participants with controllable-cameras changes.
|
1738
|
+
*
|
1739
|
+
* @internal
|
1740
|
+
* Limited to Microsoft-internal use
|
1243
1741
|
*/
|
1244
1742
|
function registerOnCapableParticipantsChangeHandler(handler: (participantChange: Participant[]) => void): void;
|
1245
1743
|
/**
|
@@ -1248,6 +1746,9 @@ export namespace remoteCamera {
|
|
1248
1746
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
1249
1747
|
*
|
1250
1748
|
* @param handler - The handler to invoke when there is an error from the camera handler.
|
1749
|
+
*
|
1750
|
+
* @internal
|
1751
|
+
* Limited to Microsoft-internal use
|
1251
1752
|
*/
|
1252
1753
|
function registerOnErrorHandler(handler: (error: ErrorReason) => void): void;
|
1253
1754
|
/**
|
@@ -1256,6 +1757,9 @@ export namespace remoteCamera {
|
|
1256
1757
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
1257
1758
|
*
|
1258
1759
|
* @param handler - The handler to invoke when the controlled device changes state.
|
1760
|
+
*
|
1761
|
+
* @internal
|
1762
|
+
* Limited to Microsoft-internal use
|
1259
1763
|
*/
|
1260
1764
|
function registerOnDeviceStateChangeHandler(handler: (deviceStateChange: DeviceState) => void): void;
|
1261
1765
|
/**
|
@@ -1264,46 +1768,76 @@ export namespace remoteCamera {
|
|
1264
1768
|
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
1265
1769
|
*
|
1266
1770
|
* @param handler - The handler to invoke when the current session status changes.
|
1771
|
+
*
|
1772
|
+
* @internal
|
1773
|
+
* Limited to Microsoft-internal use
|
1267
1774
|
*/
|
1268
1775
|
function registerOnSessionStatusChangeHandler(handler: (sessionStatusChange: SessionStatus) => void): void;
|
1776
|
+
/**
|
1777
|
+
* @hidden
|
1778
|
+
* @returns boolean to represent whether the remoteCamera capability is supported
|
1779
|
+
*
|
1780
|
+
* @internal
|
1781
|
+
* Limited to Microsoft-internal use
|
1782
|
+
*/
|
1269
1783
|
function isSupported(): boolean;
|
1270
1784
|
}
|
1271
1785
|
|
1272
1786
|
/**
|
1273
1787
|
* @hidden
|
1274
1788
|
* Namespace to interact with the application entities specific part of the SDK.
|
1789
|
+
*
|
1790
|
+
* @internal
|
1791
|
+
* Limited to Microsoft-internal use
|
1275
1792
|
*/
|
1276
1793
|
export namespace appEntity {
|
1277
1794
|
/**
|
1278
1795
|
* @hidden
|
1279
|
-
*
|
1280
|
-
* --------
|
1796
|
+
*
|
1281
1797
|
* Information on an app entity
|
1798
|
+
*
|
1799
|
+
* @internal
|
1800
|
+
* Limited to Microsoft-internal use
|
1282
1801
|
*/
|
1283
1802
|
interface AppEntity {
|
1284
1803
|
/**
|
1285
1804
|
* @hidden
|
1286
1805
|
* ID of the application
|
1806
|
+
*
|
1807
|
+
* @internal
|
1808
|
+
* Limited to Microsoft-internal use
|
1287
1809
|
*/
|
1288
1810
|
appId: string;
|
1289
1811
|
/**
|
1290
1812
|
* @hidden
|
1291
1813
|
* URL for the application's icon
|
1814
|
+
*
|
1815
|
+
* @internal
|
1816
|
+
* Limited to Microsoft-internal use
|
1292
1817
|
*/
|
1293
1818
|
appIconUrl: string;
|
1294
1819
|
/**
|
1295
1820
|
* @hidden
|
1296
1821
|
* Content URL for the app entity
|
1822
|
+
*
|
1823
|
+
* @internal
|
1824
|
+
* Limited to Microsoft-internal use
|
1297
1825
|
*/
|
1298
1826
|
contentUrl: string;
|
1299
1827
|
/**
|
1300
1828
|
* @hidden
|
1301
1829
|
* The display name for the app entity
|
1830
|
+
*
|
1831
|
+
* @internal
|
1832
|
+
* Limited to Microsoft-internal use
|
1302
1833
|
*/
|
1303
1834
|
displayName: string;
|
1304
1835
|
/**
|
1305
1836
|
* @hidden
|
1306
1837
|
* Website URL for the app entity. It is meant to be opened by the user in a browser.
|
1838
|
+
*
|
1839
|
+
* @internal
|
1840
|
+
* Limited to Microsoft-internal use
|
1307
1841
|
*/
|
1308
1842
|
websiteUrl: string;
|
1309
1843
|
}
|
@@ -1319,12 +1853,20 @@ export namespace appEntity {
|
|
1319
1853
|
* @param callback Callback that will be triggered once the app entity information is available.
|
1320
1854
|
* The callback takes two arguments: an SdkError in case something happened (i.e.
|
1321
1855
|
* no permissions to execute the API) and the app entity configuration, if available
|
1856
|
+
*
|
1857
|
+
* @internal
|
1858
|
+
* Limited to Microsoft-internal use
|
1322
1859
|
*/
|
1323
1860
|
function selectAppEntity(threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void): void;
|
1324
1861
|
/**
|
1862
|
+
* @hidden
|
1863
|
+
*
|
1325
1864
|
* Checks if appEntity capability is supported by the host
|
1326
1865
|
* @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
|
1327
1866
|
* false if it is disabled
|
1867
|
+
*
|
1868
|
+
* @internal
|
1869
|
+
* Limited to Microsoft-internal use
|
1328
1870
|
*/
|
1329
1871
|
function isSupported(): boolean;
|
1330
1872
|
}
|
@@ -1332,10 +1874,9 @@ export namespace appEntity {
|
|
1332
1874
|
/**
|
1333
1875
|
* @hidden
|
1334
1876
|
* Namespace to interact with the `teams` specific part of the SDK.
|
1335
|
-
* ------
|
1336
|
-
* Hide from docs
|
1337
1877
|
*
|
1338
1878
|
* @internal
|
1879
|
+
* Limited to Microsoft-internal use
|
1339
1880
|
*/
|
1340
1881
|
export namespace teams {
|
1341
1882
|
enum ChannelType {
|
@@ -1343,6 +1884,12 @@ export namespace teams {
|
|
1343
1884
|
Private = 1,
|
1344
1885
|
Shared = 2
|
1345
1886
|
}
|
1887
|
+
/**
|
1888
|
+
* @hidden
|
1889
|
+
*
|
1890
|
+
* @internal
|
1891
|
+
* Limited to Microsoft-internal use
|
1892
|
+
*/
|
1346
1893
|
interface ChannelInfo {
|
1347
1894
|
siteUrl: string;
|
1348
1895
|
objectId: string;
|
@@ -1352,11 +1899,12 @@ export namespace teams {
|
|
1352
1899
|
}
|
1353
1900
|
/**
|
1354
1901
|
* @hidden
|
1355
|
-
* Hide from docs
|
1356
|
-
* ------
|
1357
1902
|
* Get a list of channels belong to a Team
|
1358
1903
|
*
|
1359
1904
|
* @param groupId - a team's objectId
|
1905
|
+
*
|
1906
|
+
* @internal
|
1907
|
+
* Limited to Microsoft-internal use
|
1360
1908
|
*/
|
1361
1909
|
function getTeamChannels(groupId: string, callback: (error: SdkError, channels: ChannelInfo[]) => void): void;
|
1362
1910
|
/**
|
@@ -1366,6 +1914,9 @@ export namespace teams {
|
|
1366
1914
|
*
|
1367
1915
|
* @param threadId - ID of the thread where the app entity will be created; if threadId is not
|
1368
1916
|
* provided, the threadId from route params will be used.
|
1917
|
+
*
|
1918
|
+
* @internal
|
1919
|
+
* Limited to Microsoft-internal use
|
1369
1920
|
*/
|
1370
1921
|
function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
|
1371
1922
|
/**
|
@@ -1374,55 +1925,65 @@ export namespace teams {
|
|
1374
1925
|
*
|
1375
1926
|
* @returns true if the teams capability is enabled in runtime.supports.teams and
|
1376
1927
|
* false if it is disabled
|
1928
|
+
*
|
1929
|
+
* @internal
|
1930
|
+
* Limited to Microsoft-internal use
|
1377
1931
|
*/
|
1378
1932
|
function isSupported(): boolean;
|
1379
1933
|
/**
|
1380
1934
|
* @hidden
|
1381
|
-
* Hide from docs
|
1382
|
-
* ------
|
1383
|
-
*
|
1384
1935
|
* @internal
|
1936
|
+
* Limited to Microsoft-internal use
|
1385
1937
|
*/
|
1386
1938
|
namespace fullTrust {
|
1939
|
+
/**
|
1940
|
+
* @hidden
|
1941
|
+
* @internal
|
1942
|
+
* Limited to Microsoft-internal use
|
1943
|
+
*/
|
1387
1944
|
namespace joinedTeams {
|
1388
1945
|
/**
|
1389
1946
|
* @hidden
|
1390
|
-
* Hide from docs
|
1391
|
-
* ------
|
1392
1947
|
* Allows an app to retrieve information of all user joined teams
|
1393
1948
|
*
|
1394
1949
|
* @param teamInstanceParameters - Optional flags that specify whether to scope call to favorite teams
|
1395
1950
|
* @returns Promise that resolves with information about the user joined teams or rejects with an error when the operation has completed
|
1951
|
+
*
|
1952
|
+
* @internal
|
1953
|
+
* Limited to Microsoft-internal use
|
1396
1954
|
*/
|
1397
1955
|
function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
|
1398
1956
|
/**
|
1399
1957
|
* @hidden
|
1400
|
-
* Hide from docs
|
1401
|
-
* ------
|
1402
1958
|
* Checks if teams.fullTrust.joinedTeams capability is supported by the host
|
1403
1959
|
*
|
1404
1960
|
* @returns true if the teams.fullTrust.joinedTeams capability is enabled in
|
1405
1961
|
* runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
|
1962
|
+
*
|
1963
|
+
* @internal
|
1964
|
+
* Limited to Microsoft-internal use
|
1406
1965
|
*/
|
1407
1966
|
function isSupported(): boolean;
|
1408
1967
|
}
|
1409
1968
|
/**
|
1410
1969
|
* @hidden
|
1411
|
-
* Hide from docs
|
1412
|
-
* ------
|
1413
1970
|
* Allows an app to get the configuration setting value
|
1414
1971
|
*
|
1415
1972
|
* @param key - The key for the config setting
|
1416
1973
|
* @returns Promise that resolves with the value for the provided configuration setting or rejects with an error when the operation has completed
|
1974
|
+
*
|
1975
|
+
* @internal
|
1976
|
+
* Limited to Microsoft-internal use
|
1417
1977
|
*/
|
1418
1978
|
function getConfigSetting(key: string): Promise<string>;
|
1419
1979
|
/**
|
1420
1980
|
* @hidden
|
1421
|
-
* Hide from docs
|
1422
|
-
* ------
|
1423
1981
|
* Checks if teams.fullTrust capability is supported by the host
|
1424
1982
|
* @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
|
1425
1983
|
* false if it is disabled
|
1984
|
+
*
|
1985
|
+
* @internal
|
1986
|
+
* Limited to Microsoft-internal use
|
1426
1987
|
*/
|
1427
1988
|
function isSupported(): boolean;
|
1428
1989
|
}
|
@@ -1488,13 +2049,12 @@ export namespace authentication {
|
|
1488
2049
|
function getAuthToken(authTokenRequest?: AuthTokenRequest): void;
|
1489
2050
|
/**
|
1490
2051
|
* @hidden
|
1491
|
-
* Hide from docs.
|
1492
|
-
* ------
|
1493
2052
|
* Requests the decoded Azure AD user identity on behalf of the app.
|
1494
2053
|
*
|
1495
2054
|
* @returns Promise that resolves with the {@link UserProfile}.
|
1496
2055
|
*
|
1497
2056
|
* @internal
|
2057
|
+
* Limited to Microsoft-internal use
|
1498
2058
|
*/
|
1499
2059
|
function getUser(): Promise<UserProfile>;
|
1500
2060
|
/**
|
@@ -1502,12 +2062,11 @@ export namespace authentication {
|
|
1502
2062
|
* As of 2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
|
1503
2063
|
*
|
1504
2064
|
* @hidden
|
1505
|
-
* Hide from docs.
|
1506
|
-
* ------
|
1507
2065
|
* Requests the decoded Azure AD user identity on behalf of the app.
|
1508
2066
|
*
|
1509
2067
|
* @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
|
1510
2068
|
* @internal
|
2069
|
+
* Limited to Microsoft-internal use
|
1511
2070
|
*/
|
1512
2071
|
function getUser(userRequest: UserRequest): void;
|
1513
2072
|
/**
|
@@ -1602,26 +2161,34 @@ export namespace authentication {
|
|
1602
2161
|
type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
|
1603
2162
|
/**
|
1604
2163
|
* @hidden
|
1605
|
-
* Hide from docs.
|
1606
|
-
* ------
|
1607
2164
|
*
|
1608
2165
|
* @internal
|
2166
|
+
* Limited to Microsoft-internal use
|
1609
2167
|
*/
|
1610
2168
|
interface UserProfile {
|
1611
2169
|
/**
|
1612
2170
|
* @hidden
|
1613
2171
|
* The intended recipient of the token. The application that receives the token must verify that the audience
|
1614
2172
|
* value is correct and reject any tokens intended for a different audience.
|
2173
|
+
*
|
2174
|
+
* @internal
|
2175
|
+
* Limited to Microsoft-internal use
|
1615
2176
|
*/
|
1616
2177
|
aud: string;
|
1617
2178
|
/**
|
1618
2179
|
* @hidden
|
1619
2180
|
* Identifies how the subject of the token was authenticated.
|
2181
|
+
*
|
2182
|
+
* @internal
|
2183
|
+
* Limited to Microsoft-internal use
|
1620
2184
|
*/
|
1621
2185
|
amr: string[];
|
1622
2186
|
/**
|
1623
2187
|
* @hidden
|
1624
2188
|
* Stores the time at which the token was issued. It is often used to measure token freshness.
|
2189
|
+
*
|
2190
|
+
* @internal
|
2191
|
+
* Limited to Microsoft-internal use
|
1625
2192
|
*/
|
1626
2193
|
iat: number;
|
1627
2194
|
/**
|
@@ -1629,28 +2196,43 @@ export namespace authentication {
|
|
1629
2196
|
* Identifies the security token service (STS) that constructs and returns the token. In the tokens that Azure AD
|
1630
2197
|
* returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Azure AD
|
1631
2198
|
* directory. The tenant ID is an immutable and reliable identifier of the directory.
|
2199
|
+
*
|
2200
|
+
* @internal
|
2201
|
+
* Limited to Microsoft-internal use
|
1632
2202
|
*/
|
1633
2203
|
iss: string;
|
1634
2204
|
/**
|
1635
2205
|
* @hidden
|
1636
2206
|
* Provides the last name, surname, or family name of the user as defined in the Azure AD user object.
|
2207
|
+
*
|
2208
|
+
* @internal
|
2209
|
+
* Limited to Microsoft-internal use
|
1637
2210
|
*/
|
1638
2211
|
family_name: string;
|
1639
2212
|
/**
|
1640
2213
|
* @hidden
|
1641
2214
|
* Provides the first or "given" name of the user, as set on the Azure AD user object.
|
2215
|
+
*
|
2216
|
+
* @internal
|
2217
|
+
* Limited to Microsoft-internal use
|
1642
2218
|
*/
|
1643
2219
|
given_name: string;
|
1644
2220
|
/**
|
1645
2221
|
* @hidden
|
1646
2222
|
* Provides a human-readable value that identifies the subject of the token. This value is not guaranteed to
|
1647
2223
|
* be unique within a tenant and is designed to be used only for display purposes.
|
2224
|
+
*
|
2225
|
+
* @internal
|
2226
|
+
* Limited to Microsoft-internal use
|
1648
2227
|
*/
|
1649
2228
|
unique_name: string;
|
1650
2229
|
/**
|
1651
2230
|
* @hidden
|
1652
2231
|
* Contains a unique identifier of an object in Azure AD. This value is immutable and cannot be reassigned or
|
1653
2232
|
* reused. Use the object ID to identify an object in queries to Azure AD.
|
2233
|
+
*
|
2234
|
+
* @internal
|
2235
|
+
* Limited to Microsoft-internal use
|
1654
2236
|
*/
|
1655
2237
|
oid: string;
|
1656
2238
|
/**
|
@@ -1659,6 +2241,9 @@ export namespace authentication {
|
|
1659
2241
|
* This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
|
1660
2242
|
* checks safely. Because the subject is always present in the tokens the Azure AD issues, we recommended
|
1661
2243
|
* using this value in a general-purpose authorization system.
|
2244
|
+
*
|
2245
|
+
* @internal
|
2246
|
+
* Limited to Microsoft-internal use
|
1662
2247
|
*/
|
1663
2248
|
sub: string;
|
1664
2249
|
/**
|
@@ -1666,6 +2251,9 @@ export namespace authentication {
|
|
1666
2251
|
* An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can
|
1667
2252
|
* use this value to access tenant-specific directory resources in a multitenant application. For example,
|
1668
2253
|
* you can use this value to identify the tenant in a call to the Graph API.
|
2254
|
+
*
|
2255
|
+
* @internal
|
2256
|
+
* Limited to Microsoft-internal use
|
1669
2257
|
*/
|
1670
2258
|
tid: string;
|
1671
2259
|
/**
|
@@ -1674,6 +2262,9 @@ export namespace authentication {
|
|
1674
2262
|
* should verify that the current date is within the token lifetime; otherwise it should reject the token. The
|
1675
2263
|
* service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
|
1676
2264
|
* time ("time skew") between Azure AD and the service.
|
2265
|
+
*
|
2266
|
+
* @internal
|
2267
|
+
* Limited to Microsoft-internal use
|
1677
2268
|
*/
|
1678
2269
|
exp: number;
|
1679
2270
|
/**
|
@@ -1682,16 +2273,25 @@ export namespace authentication {
|
|
1682
2273
|
* should verify that the current date is within the token lifetime; otherwise it should reject the token. The
|
1683
2274
|
* service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
|
1684
2275
|
* time ("time skew") between Azure AD and the service.
|
2276
|
+
*
|
2277
|
+
* @internal
|
2278
|
+
* Limited to Microsoft-internal use
|
1685
2279
|
*/
|
1686
2280
|
nbf: number;
|
1687
2281
|
/**
|
1688
2282
|
* @hidden
|
1689
2283
|
* Stores the user name of the user principal.
|
2284
|
+
*
|
2285
|
+
* @internal
|
2286
|
+
* Limited to Microsoft-internal use
|
1690
2287
|
*/
|
1691
2288
|
upn: string;
|
1692
2289
|
/**
|
1693
2290
|
* @hidden
|
1694
2291
|
* Stores the version number of the token.
|
2292
|
+
*
|
2293
|
+
* @internal
|
2294
|
+
* Limited to Microsoft-internal use
|
1695
2295
|
*/
|
1696
2296
|
ver: string;
|
1697
2297
|
}
|
@@ -1699,11 +2299,10 @@ export namespace authentication {
|
|
1699
2299
|
* @deprecated
|
1700
2300
|
* As of 2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
|
1701
2301
|
* @hidden
|
1702
|
-
* Hide from docs.
|
1703
|
-
* ------
|
1704
2302
|
* Describes the UserRequest. Success callback describes how a successful request is handled.
|
1705
2303
|
* Failure callback describes how a failed request is handled.
|
1706
2304
|
* @internal
|
2305
|
+
* Limited to Microsoft-internal use
|
1707
2306
|
*/
|
1708
2307
|
interface UserRequest {
|
1709
2308
|
/**
|
@@ -1808,6 +2407,7 @@ export interface TabInstance {
|
|
1808
2407
|
tabName: string;
|
1809
2408
|
/**
|
1810
2409
|
* @internal
|
2410
|
+
* Limited to Microsoft-internal use
|
1811
2411
|
* @protected
|
1812
2412
|
*/
|
1813
2413
|
internalTabInstanceId?: string;
|
@@ -1931,20 +2531,95 @@ export enum FileOpenPreference {
|
|
1931
2531
|
Desktop = "desktop",
|
1932
2532
|
Web = "web"
|
1933
2533
|
}
|
2534
|
+
/**
|
2535
|
+
* Possible Action Types
|
2536
|
+
*
|
2537
|
+
* @beta
|
2538
|
+
*/
|
2539
|
+
export enum ActionObjectType {
|
2540
|
+
M365Content = "m365content"
|
2541
|
+
}
|
2542
|
+
/**
|
2543
|
+
* Data pertaining to object(s) the action is being performed on
|
2544
|
+
*
|
2545
|
+
* @param T The type of action being implemented
|
2546
|
+
*
|
2547
|
+
* @beta
|
2548
|
+
*/
|
2549
|
+
export interface BaseActionObject<T extends ActionObjectType> {
|
2550
|
+
type: T;
|
2551
|
+
}
|
2552
|
+
/**
|
2553
|
+
* Stores information needed to represent M365 Content stored
|
2554
|
+
* in OneDrive or Sharepoint
|
2555
|
+
*
|
2556
|
+
* @beta
|
2557
|
+
*/
|
2558
|
+
export interface M365ContentAction extends BaseActionObject<ActionObjectType.M365Content> {
|
2559
|
+
/**
|
2560
|
+
* Only office content IDs are passed to the app. Apps should use these ids
|
2561
|
+
* to query the Microsoft graph for more details.
|
2562
|
+
*/
|
2563
|
+
itemId: string;
|
2564
|
+
secondaryId?: SecondaryId;
|
2565
|
+
}
|
2566
|
+
/**
|
2567
|
+
* Contains information on what Graph item is being queried
|
2568
|
+
*
|
2569
|
+
* @beta
|
2570
|
+
*/
|
2571
|
+
export interface SecondaryId {
|
2572
|
+
name: SecondaryM365ContentIdName;
|
2573
|
+
value: string;
|
2574
|
+
}
|
2575
|
+
/**
|
2576
|
+
* These correspond with field names in the MSGraph
|
2577
|
+
*
|
2578
|
+
* @beta
|
2579
|
+
*/
|
2580
|
+
export enum SecondaryM365ContentIdName {
|
2581
|
+
DriveId = "driveId",
|
2582
|
+
GroupId = "groupId",
|
2583
|
+
SiteId = "siteId",
|
2584
|
+
UserId = "userId"
|
2585
|
+
}
|
2586
|
+
/**
|
2587
|
+
* Information common to all actions
|
2588
|
+
*
|
2589
|
+
* @beta
|
2590
|
+
*/
|
2591
|
+
export interface ActionInfo {
|
2592
|
+
/**
|
2593
|
+
* Maps to the action id supplied inside the manifest
|
2594
|
+
*/
|
2595
|
+
actionId: string;
|
2596
|
+
/**
|
2597
|
+
* Array of corresponding action objects
|
2598
|
+
*/
|
2599
|
+
actionObjects: BaseActionObject<ActionObjectType>[];
|
2600
|
+
}
|
1934
2601
|
/**
|
1935
2602
|
* @deprecated
|
1936
|
-
* As of 2.0.0, please use {@link app.Context} instead.
|
2603
|
+
* As of 2.0.0, please use the {@link app.Context} interface and its updated properties instead.
|
1937
2604
|
*
|
1938
2605
|
* @remarks
|
1939
|
-
* For more details
|
1940
|
-
*
|
2606
|
+
* For more details about the updated {@link app.Context} interface, visit the
|
2607
|
+
* [Teams JavaScript client SDK](https://docs.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface)
|
2608
|
+
* overview article.
|
1941
2609
|
*
|
1942
2610
|
* Represents the structure of the received context message.
|
1943
2611
|
*/
|
1944
2612
|
export interface Context {
|
1945
2613
|
/**
|
1946
2614
|
* @deprecated
|
1947
|
-
* As of 2.0.0, please use {@link app.Context.
|
2615
|
+
* As of 2.0.0, please use {@link ActionInfo | app.Context.actionInfo} instead
|
2616
|
+
*
|
2617
|
+
* Common information applicable to all content actions
|
2618
|
+
*/
|
2619
|
+
actionInfo?: ActionInfo;
|
2620
|
+
/**
|
2621
|
+
* @deprecated
|
2622
|
+
* As of 2.0.0, please use {@link app.TeamInfo.groupId | app.Context.team.groupId} instead
|
1948
2623
|
*
|
1949
2624
|
* The Office 365 group ID for the team with which the content is associated.
|
1950
2625
|
* This field is available only when the identity permission is requested in the manifest.
|
@@ -1952,49 +2627,49 @@ export interface Context {
|
|
1952
2627
|
groupId?: string;
|
1953
2628
|
/**
|
1954
2629
|
* @deprecated
|
1955
|
-
* As of 2.0.0, please use {@link app.Context.team.internalId} instead
|
2630
|
+
* As of 2.0.0, please use {@link app.TeamInfo.internalId | app.Context.team.internalId} instead
|
1956
2631
|
*
|
1957
2632
|
* The Microsoft Teams ID for the team with which the content is associated.
|
1958
2633
|
*/
|
1959
2634
|
teamId?: string;
|
1960
2635
|
/**
|
1961
2636
|
* @deprecated
|
1962
|
-
* As of 2.0.0, please use {@link app.Context.team.displayName} instead
|
2637
|
+
* As of 2.0.0, please use {@link app.TeamInfo.displayName | app.Context.team.displayName} instead
|
1963
2638
|
*
|
1964
2639
|
* The name for the team with which the content is associated.
|
1965
2640
|
*/
|
1966
2641
|
teamName?: string;
|
1967
2642
|
/**
|
1968
2643
|
* @deprecated
|
1969
|
-
* As of 2.0.0, please use {@link app.Context.channel.id} instead
|
2644
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.id | app.Context.channel.id} instead
|
1970
2645
|
*
|
1971
2646
|
* The Microsoft Teams ID for the channel with which the content is associated.
|
1972
2647
|
*/
|
1973
2648
|
channelId?: string;
|
1974
2649
|
/**
|
1975
2650
|
* @deprecated
|
1976
|
-
* As of 2.0.0, please use {@link app.Context.channel.displayName} instead
|
2651
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.displayName | app.Context.channel.displayName} instead
|
1977
2652
|
*
|
1978
2653
|
* The name for the channel with which the content is associated.
|
1979
2654
|
*/
|
1980
2655
|
channelName?: string;
|
1981
2656
|
/**
|
1982
2657
|
* @deprecated
|
1983
|
-
* As of 2.0.0, please use {@link app.Context.channel.membershipType} instead
|
2658
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.membershipType | app.Context.channel.membershipType} instead
|
1984
2659
|
*
|
1985
2660
|
* The type of the channel with which the content is associated.
|
1986
2661
|
*/
|
1987
2662
|
channelType?: ChannelType;
|
1988
2663
|
/**
|
1989
2664
|
* @deprecated
|
1990
|
-
* As of 2.0.0, please use {@link app.Context.page.id} instead
|
2665
|
+
* As of 2.0.0, please use {@link app.PageInfo.id | app.Context.page.id} instead
|
1991
2666
|
*
|
1992
2667
|
* The developer-defined unique ID for the entity this content points to.
|
1993
2668
|
*/
|
1994
2669
|
entityId: string;
|
1995
2670
|
/**
|
1996
2671
|
* @deprecated
|
1997
|
-
* As of 2.0.0, please use {@link app.Context.page.subPageId} instead
|
2672
|
+
* As of 2.0.0, please use {@link app.PageInfo.subPageId | app.Context.page.subPageId} instead
|
1998
2673
|
*
|
1999
2674
|
* The developer-defined unique ID for the sub-entity this content points to.
|
2000
2675
|
* This field should be used to restore to a specific state within an entity,
|
@@ -2003,7 +2678,7 @@ export interface Context {
|
|
2003
2678
|
subEntityId?: string;
|
2004
2679
|
/**
|
2005
2680
|
* @deprecated
|
2006
|
-
* As of 2.0.0, please use {@link app.Context.app.locale} instead
|
2681
|
+
* As of 2.0.0, please use {@link app.AppInfo.locale | app.Context.app.locale} instead
|
2007
2682
|
*
|
2008
2683
|
* The current locale that the user has configured for the app formatted as
|
2009
2684
|
* languageId-countryId (for example, en-us).
|
@@ -2011,7 +2686,7 @@ export interface Context {
|
|
2011
2686
|
locale: string;
|
2012
2687
|
/**
|
2013
2688
|
* @deprecated
|
2014
|
-
* As of 2.0.0, please use {@link app.Context.app.osLocaleInfo} instead
|
2689
|
+
* As of 2.0.0, please use {@link app.AppInfo.osLocaleInfo | app.Context.app.osLocaleInfo} instead
|
2015
2690
|
*
|
2016
2691
|
* More detailed locale info from the user's OS if available. Can be used together with
|
2017
2692
|
* the @microsoft/globe NPM package to ensure your app respects the user's OS date and
|
@@ -2021,7 +2696,8 @@ export interface Context {
|
|
2021
2696
|
/**
|
2022
2697
|
* @deprecated
|
2023
2698
|
*
|
2024
|
-
* As of 2.0.0, please use {@link app.
|
2699
|
+
* As of 2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} or
|
2700
|
+
* {@link app.UserInfo.userPrincipalName | app.Context.user.userPrincipalName} instead.
|
2025
2701
|
* The UPN of the current user.
|
2026
2702
|
* Because a malicious party can run your content in a browser, this value should
|
2027
2703
|
* be used only as a hint as to who the user is and never as proof of identity.
|
@@ -2030,7 +2706,7 @@ export interface Context {
|
|
2030
2706
|
upn?: string;
|
2031
2707
|
/**
|
2032
2708
|
* @deprecated
|
2033
|
-
* As of 2.0.0, please use {@link app.Context.user.tenant.id} instead
|
2709
|
+
* As of 2.0.0, please use {@link app.TenantInfo.id | app.Context.user.tenant.id} instead
|
2034
2710
|
*
|
2035
2711
|
* The Azure AD tenant ID of the current user.
|
2036
2712
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -2040,77 +2716,77 @@ export interface Context {
|
|
2040
2716
|
tid?: string;
|
2041
2717
|
/**
|
2042
2718
|
* @deprecated
|
2043
|
-
* As of 2.0.0, please use {@link app.Context.app.theme} instead
|
2719
|
+
* As of 2.0.0, please use {@link app.AppInfo.theme | app.Context.app.theme} instead
|
2044
2720
|
*
|
2045
2721
|
* The current UI theme.
|
2046
2722
|
*/
|
2047
2723
|
theme?: string;
|
2048
2724
|
/**
|
2049
2725
|
* @deprecated
|
2050
|
-
* As of 2.0.0, please use {@link app.Context.page.isFullScreen} instead
|
2726
|
+
* As of 2.0.0, please use {@link app.PageInfo.isFullScreen | app.Context.page.isFullScreen} instead
|
2051
2727
|
*
|
2052
2728
|
* Indication whether the tab is in full-screen mode.
|
2053
2729
|
*/
|
2054
2730
|
isFullScreen?: boolean;
|
2055
2731
|
/**
|
2056
2732
|
* @deprecated
|
2057
|
-
* As of 2.0.0, please use {@link app.Context.team.type} instead
|
2733
|
+
* As of 2.0.0, please use {@link app.TeamInfo.type | app.Context.team.type} instead
|
2058
2734
|
*
|
2059
2735
|
* The type of the team.
|
2060
2736
|
*/
|
2061
2737
|
teamType?: TeamType;
|
2062
2738
|
/**
|
2063
2739
|
* @deprecated
|
2064
|
-
* As of 2.0.0, please use {@link app.Context.sharePointSite.teamSiteUrl} instead
|
2740
|
+
* As of 2.0.0, please use {@link app.SharePointSiteInfo.teamSiteUrl | app.Context.sharePointSite.teamSiteUrl} instead
|
2065
2741
|
*
|
2066
2742
|
* The root SharePoint site associated with the team.
|
2067
2743
|
*/
|
2068
2744
|
teamSiteUrl?: string;
|
2069
2745
|
/**
|
2070
2746
|
* @deprecated
|
2071
|
-
* As of 2.0.0, please use {@link app.Context.sharePointSite.teamSiteDomain} instead
|
2747
|
+
* As of 2.0.0, please use {@link app.SharePointSiteInfo.teamSiteDomain | app.Context.sharePointSite.teamSiteDomain} instead
|
2072
2748
|
*
|
2073
2749
|
* The domain of the root SharePoint site associated with the team.
|
2074
2750
|
*/
|
2075
2751
|
teamSiteDomain?: string;
|
2076
2752
|
/**
|
2077
2753
|
* @deprecated
|
2078
|
-
* As of 2.0.0, please use {@link app.Context.sharePointSite.teamSitePath} instead
|
2754
|
+
* As of 2.0.0, please use {@link app.SharePointSiteInfo.teamSitePath | app.Context.sharePointSite.teamSitePath} instead
|
2079
2755
|
*
|
2080
2756
|
* The relative path to the SharePoint site associated with the team.
|
2081
2757
|
*/
|
2082
2758
|
teamSitePath?: string;
|
2083
2759
|
/**
|
2084
2760
|
* @deprecated
|
2085
|
-
* As of 2.0.0, please use {@link app.Context.channel.
|
2761
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.ownerTenantId | app.Context.channel.ownerTenantId} instead
|
2086
2762
|
*
|
2087
2763
|
* The tenant ID of the host team.
|
2088
2764
|
*/
|
2089
2765
|
hostTeamTenantId?: string;
|
2090
2766
|
/**
|
2091
2767
|
* @deprecated
|
2092
|
-
* As of 2.0.0, please use {@link app.Context.channel.ownerGroupId} instead
|
2768
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.ownerGroupId | app.Context.channel.ownerGroupId} instead
|
2093
2769
|
*
|
2094
2770
|
* The AAD group ID of the host team.
|
2095
2771
|
*/
|
2096
2772
|
hostTeamGroupId?: string;
|
2097
2773
|
/**
|
2098
2774
|
* @deprecated
|
2099
|
-
* As of 2.0.0, please use {@link app.Context.channel.relativeUrl} instead
|
2775
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.relativeUrl | app.Context.channel.relativeUrl} instead
|
2100
2776
|
*
|
2101
2777
|
* The relative path to the SharePoint folder associated with the channel.
|
2102
2778
|
*/
|
2103
2779
|
channelRelativeUrl?: string;
|
2104
2780
|
/**
|
2105
2781
|
* @deprecated
|
2106
|
-
* As of 2.0.0, please use {@link app.Context.app.host.sessionId} instead
|
2782
|
+
* As of 2.0.0, please use {@link app.AppHostInfo.sessionId | app.Context.app.host.sessionId} instead
|
2107
2783
|
*
|
2108
2784
|
* Unique ID for the current Teams session for use in correlating telemetry data.
|
2109
2785
|
*/
|
2110
2786
|
sessionId?: string;
|
2111
2787
|
/**
|
2112
2788
|
* @deprecated
|
2113
|
-
* As of 2.0.0, please use {@link app.Context.team.userRole} instead
|
2789
|
+
* As of 2.0.0, please use {@link app.TeamInfo.userRole | app.Context.team.userRole} instead
|
2114
2790
|
*
|
2115
2791
|
* The user's role in the team.
|
2116
2792
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -2119,14 +2795,14 @@ export interface Context {
|
|
2119
2795
|
userTeamRole?: UserTeamRole;
|
2120
2796
|
/**
|
2121
2797
|
* @deprecated
|
2122
|
-
* As of 2.0.0, please use {@link app.Context.chat.id} instead
|
2798
|
+
* As of 2.0.0, please use {@link app.ChatInfo.id | app.Context.chat.id} instead
|
2123
2799
|
*
|
2124
2800
|
* The Microsoft Teams ID for the chat with which the content is associated.
|
2125
2801
|
*/
|
2126
2802
|
chatId?: string;
|
2127
2803
|
/**
|
2128
2804
|
* @deprecated
|
2129
|
-
* As of 2.0.0, please use {@link app.Context.user.loginHint} instead
|
2805
|
+
* As of 2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} instead
|
2130
2806
|
*
|
2131
2807
|
* A value suitable for use as a login_hint when authenticating with Azure AD.
|
2132
2808
|
* Because a malicious party can run your content in a browser, this value should
|
@@ -2136,7 +2812,7 @@ export interface Context {
|
|
2136
2812
|
loginHint?: string;
|
2137
2813
|
/**
|
2138
2814
|
* @deprecated
|
2139
|
-
* As of 2.0.0, please use {@link app.Context.user.userPrincipalName} instead
|
2815
|
+
* As of 2.0.0, please use {@link app.UserInfo.userPrincipalName | app.Context.user.userPrincipalName} instead
|
2140
2816
|
*
|
2141
2817
|
* The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).
|
2142
2818
|
* Because a malicious party run your content in a browser, this value should
|
@@ -2146,7 +2822,7 @@ export interface Context {
|
|
2146
2822
|
userPrincipalName?: string;
|
2147
2823
|
/**
|
2148
2824
|
* @deprecated
|
2149
|
-
* As of 2.0.0, please use {@link app.Context.user.id} instead
|
2825
|
+
* As of 2.0.0, please use {@link app.UserInfo.id | app.Context.user.id} instead
|
2150
2826
|
*
|
2151
2827
|
* The Azure AD object id of the current user.
|
2152
2828
|
* Because a malicious party run your content in a browser, this value should
|
@@ -2156,7 +2832,7 @@ export interface Context {
|
|
2156
2832
|
userObjectId?: string;
|
2157
2833
|
/**
|
2158
2834
|
* @deprecated
|
2159
|
-
* As of 2.0.0, please use {@link app.Context.team.isArchived} instead
|
2835
|
+
* As of 2.0.0, please use {@link app.TeamInfo.isArchived | app.Context.team.isArchived} instead
|
2160
2836
|
*
|
2161
2837
|
* Indicates whether team is archived.
|
2162
2838
|
* Apps should use this as a signal to prevent any changes to content associated with archived teams.
|
@@ -2164,14 +2840,14 @@ export interface Context {
|
|
2164
2840
|
isTeamArchived?: boolean;
|
2165
2841
|
/**
|
2166
2842
|
* @deprecated
|
2167
|
-
* As of 2.0.0, please use {@link app.Context.host.name} instead
|
2843
|
+
* As of 2.0.0, please use {@link app.AppHostInfo.name | app.Context.app.host.name} instead
|
2168
2844
|
*
|
2169
2845
|
* The name of the host client. Possible values are: Office, Orange, Outlook, Teams
|
2170
2846
|
*/
|
2171
2847
|
hostName?: HostName;
|
2172
2848
|
/**
|
2173
2849
|
* @deprecated
|
2174
|
-
* As of 2.0.0, please use {@link app.Context.host.clientType} instead
|
2850
|
+
* As of 2.0.0, please use {@link app.AppHostInfo.clientType | app.Context.app.host.clientType} instead
|
2175
2851
|
*
|
2176
2852
|
* The type of the host client. Possible values are : android, ios, web, desktop, rigel(deprecated, use teamsRoomsWindows instead),
|
2177
2853
|
* surfaceHub, teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
|
@@ -2179,35 +2855,35 @@ export interface Context {
|
|
2179
2855
|
hostClientType?: HostClientType;
|
2180
2856
|
/**
|
2181
2857
|
* @deprecated
|
2182
|
-
* As of 2.0.0, please use {@link app.Context.page.frameContext} instead
|
2858
|
+
* As of 2.0.0, please use {@link app.PageInfo.frameContext | app.Context.page.frameContext} instead
|
2183
2859
|
*
|
2184
2860
|
* The context where tab url is loaded (content, task, setting, remove, sidePanel)
|
2185
2861
|
*/
|
2186
2862
|
frameContext?: FrameContexts;
|
2187
2863
|
/**
|
2188
2864
|
* @deprecated
|
2189
|
-
* As of 2.0.0, please use {@link app.Context.sharepoint} instead
|
2865
|
+
* As of 2.0.0, please use {@link app.Context | app.Context.sharepoint} instead
|
2190
2866
|
*
|
2191
2867
|
* SharePoint context. This is only available when hosted in SharePoint.
|
2192
2868
|
*/
|
2193
2869
|
sharepoint?: any;
|
2194
2870
|
/**
|
2195
2871
|
* @deprecated
|
2196
|
-
* As of 2.0.0, please use {@link app.Context.
|
2872
|
+
* As of 2.0.0, please use {@link app.TenantInfo.teamsSku | app.Context.tenant.teamsSku} instead
|
2197
2873
|
*
|
2198
2874
|
* The type of license for the current users tenant.
|
2199
2875
|
*/
|
2200
2876
|
tenantSKU?: string;
|
2201
2877
|
/**
|
2202
2878
|
* @deprecated
|
2203
|
-
* As of 2.0.0, please use {@link app.Context.user.licenseType} instead
|
2879
|
+
* As of 2.0.0, please use {@link app.UserInfo.licenseType | app.Context.user.licenseType} instead
|
2204
2880
|
*
|
2205
2881
|
* The license type for the current user.
|
2206
2882
|
*/
|
2207
2883
|
userLicenseType?: string;
|
2208
2884
|
/**
|
2209
2885
|
* @deprecated
|
2210
|
-
* As of 2.0.0, please use {@link app.Context.app.parentMessageId} instead
|
2886
|
+
* As of 2.0.0, please use {@link app.AppInfo.parentMessageId | app.Context.app.parentMessageId} instead
|
2211
2887
|
*
|
2212
2888
|
* The ID of the parent message from which this task module was launched.
|
2213
2889
|
* This is only available in task modules launched from bot cards.
|
@@ -2215,119 +2891,119 @@ export interface Context {
|
|
2215
2891
|
parentMessageId?: string;
|
2216
2892
|
/**
|
2217
2893
|
* @deprecated
|
2218
|
-
* As of 2.0.0, please use {@link app.Context.app.host.ringId} instead
|
2894
|
+
* As of 2.0.0, please use {@link app.AppHostInfo.ringId | app.Context.app.host.ringId} instead
|
2219
2895
|
*
|
2220
2896
|
* Current ring ID
|
2221
2897
|
*/
|
2222
2898
|
ringId?: string;
|
2223
2899
|
/**
|
2224
2900
|
* @deprecated
|
2225
|
-
* As of 2.0.0, please use {@link app.Context.app.sessionId} instead
|
2901
|
+
* As of 2.0.0, please use {@link app.AppInfo.sessionId | app.Context.app.sessionId} instead
|
2226
2902
|
*
|
2227
2903
|
* Unique ID for the current session for use in correlating telemetry data.
|
2228
2904
|
*/
|
2229
2905
|
appSessionId?: string;
|
2230
2906
|
/**
|
2231
2907
|
* @deprecated
|
2232
|
-
* As of 2.0.0, please use {@link app.Context.app.appLaunchId} instead
|
2908
|
+
* As of 2.0.0, please use {@link app.AppInfo.appLaunchId | app.Context.app.appLaunchId} instead
|
2233
2909
|
*
|
2234
2910
|
* ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data``
|
2235
2911
|
*/
|
2236
2912
|
appLaunchId?: string;
|
2237
2913
|
/**
|
2238
2914
|
* @deprecated
|
2239
|
-
* As of 2.0.0, please use {@link app.Context.user.isCallingAllowed} instead
|
2915
|
+
* As of 2.0.0, please use {@link app.UserInfo.isCallingAllowed | app.Context.user.isCallingAllowed} instead
|
2240
2916
|
*
|
2241
2917
|
* Represents whether calling is allowed for the current logged in User
|
2242
2918
|
*/
|
2243
2919
|
isCallingAllowed?: boolean;
|
2244
2920
|
/**
|
2245
2921
|
* @deprecated
|
2246
|
-
* As of 2.0.0, please use {@link app.Context.user.isPSTNCallingAllowed} instead
|
2922
|
+
* As of 2.0.0, please use {@link app.UserInfo.isPSTNCallingAllowed | app.Context.user.isPSTNCallingAllowed} instead
|
2247
2923
|
*
|
2248
2924
|
* Represents whether PSTN calling is allowed for the current logged in User
|
2249
2925
|
*/
|
2250
2926
|
isPSTNCallingAllowed?: boolean;
|
2251
2927
|
/**
|
2252
2928
|
* @deprecated
|
2253
|
-
* As of 2.0.0, please use {@link app.Context.meeting.id} instead
|
2929
|
+
* As of 2.0.0, please use {@link app.MeetingInfo.id | app.Context.meeting.id} instead
|
2254
2930
|
*
|
2255
2931
|
* Meeting Id used by tab when running in meeting context
|
2256
2932
|
*/
|
2257
2933
|
meetingId?: string;
|
2258
2934
|
/**
|
2259
2935
|
* @deprecated
|
2260
|
-
* As of 2.0.0, please use {@link app.Context.channel.defaultOneNoteSectionId} instead
|
2936
|
+
* As of 2.0.0, please use {@link app.ChannelInfo.defaultOneNoteSectionId | app.Context.channel.defaultOneNoteSectionId} instead
|
2261
2937
|
*
|
2262
2938
|
* The OneNote section ID that is linked to the channel.
|
2263
2939
|
*/
|
2264
2940
|
defaultOneNoteSectionId?: string;
|
2265
2941
|
/**
|
2266
2942
|
* @deprecated
|
2267
|
-
* As of 2.0.0, please use {@link app.Context.page.isMultiWindow} instead
|
2943
|
+
* As of 2.0.0, please use {@link app.PageInfo.isMultiWindow | app.Context.page.isMultiWindow} instead
|
2268
2944
|
*
|
2269
2945
|
* Indication whether the tab is in a pop out window
|
2270
2946
|
*/
|
2271
2947
|
isMultiWindow?: boolean;
|
2272
2948
|
/**
|
2273
2949
|
* @deprecated
|
2274
|
-
* As of 2.0.0, please use {@link app.Context.app.iconPositionVertical} instead
|
2950
|
+
* As of 2.0.0, please use {@link app.AppInfo.iconPositionVertical | app.Context.app.iconPositionVertical} instead
|
2275
2951
|
*
|
2276
2952
|
* Personal app icon y coordinate position
|
2277
2953
|
*/
|
2278
2954
|
appIconPosition?: number;
|
2279
2955
|
/**
|
2280
2956
|
* @deprecated
|
2281
|
-
* As of 2.0.0, please use {@link app.Context.page.sourceOrigin} instead
|
2957
|
+
* As of 2.0.0, please use {@link app.PageInfo.sourceOrigin | app.Context.page.sourceOrigin} instead
|
2282
2958
|
*
|
2283
2959
|
* Source origin from where the tab is opened
|
2284
2960
|
*/
|
2285
2961
|
sourceOrigin?: string;
|
2286
2962
|
/**
|
2287
2963
|
* @deprecated
|
2288
|
-
* As of 2.0.0, please use {@link app.Context.app.userClickTime} instead
|
2964
|
+
* As of 2.0.0, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} instead
|
2289
2965
|
*
|
2290
2966
|
* Time when the user clicked on the tab
|
2291
2967
|
*/
|
2292
2968
|
userClickTime?: number;
|
2293
2969
|
/**
|
2294
2970
|
* @deprecated
|
2295
|
-
* As of 2.0.0, please use {@link app.Context.team.templateId} instead
|
2971
|
+
* As of 2.0.0, please use {@link app.TeamInfo.templateId | app.Context.team.templateId} instead
|
2296
2972
|
*
|
2297
2973
|
* Team Template ID if there was a Team Template associated with the creation of the team.
|
2298
2974
|
*/
|
2299
2975
|
teamTemplateId?: string;
|
2300
2976
|
/**
|
2301
2977
|
* @deprecated
|
2302
|
-
* As of 2.0.0, please use {@link app.Context.app.userFileOpenPreference} instead
|
2978
|
+
* As of 2.0.0, please use {@link app.AppInfo.userFileOpenPreference | app.Context.app.userFileOpenPreference} instead
|
2303
2979
|
*
|
2304
2980
|
* Where the user prefers the file to be opened from by default during file open
|
2305
2981
|
*/
|
2306
2982
|
userFileOpenPreference?: FileOpenPreference;
|
2307
2983
|
/**
|
2308
2984
|
* @deprecated
|
2309
|
-
* As of 2.0.0, please use {@link app.Context.user.displayName} instead
|
2985
|
+
* As of 2.0.0, please use {@link app.UserInfo.displayName | app.Context.user.displayName} instead
|
2310
2986
|
*
|
2311
2987
|
* The address book name of the current user.
|
2312
2988
|
*/
|
2313
2989
|
userDisplayName?: string;
|
2314
2990
|
/**
|
2315
2991
|
* @deprecated
|
2316
|
-
* As of 2.0.0, please use {@link app.Context.sharePointSite.teamSiteId} instead
|
2992
|
+
* As of 2.0.0, please use {@link app.SharePointSiteInfo.teamSiteId | app.Context.sharePointSite.teamSiteId} instead
|
2317
2993
|
*
|
2318
2994
|
* Teamsite ID, aka sharepoint site id.
|
2319
2995
|
*/
|
2320
2996
|
teamSiteId?: string;
|
2321
2997
|
/**
|
2322
2998
|
* @deprecated
|
2323
|
-
* As of 2.0.0, please use {@link app.Context.sharePointSite.mySiteDomain} instead
|
2999
|
+
* As of 2.0.0, please use {@link app.SharePointSiteInfo.mySiteDomain | app.Context.sharePointSite.mySiteDomain} instead
|
2324
3000
|
*
|
2325
3001
|
* The SharePoint my site domain associated with the user.
|
2326
3002
|
*/
|
2327
3003
|
mySiteDomain?: string;
|
2328
3004
|
/**
|
2329
3005
|
* @deprecated
|
2330
|
-
* As of 2.0.0, please use {@link app.Context.sharePointSite.mySitePath} instead
|
3006
|
+
* As of 2.0.0, please use {@link app.SharePointSiteInfo.mySitePath | app.Context.sharePointSite.mySitePath} instead
|
2331
3007
|
*
|
2332
3008
|
* The SharePoint relative path to the current users mysite
|
2333
3009
|
*/
|
@@ -2465,9 +3141,9 @@ export interface DialogSize {
|
|
2465
3141
|
}
|
2466
3142
|
/**
|
2467
3143
|
* @hidden
|
2468
|
-
* Hide from docs.
|
2469
3144
|
*
|
2470
3145
|
* @internal
|
3146
|
+
* Limited to Microsoft-internal use
|
2471
3147
|
*/
|
2472
3148
|
export interface LoadContext {
|
2473
3149
|
/**
|
@@ -2939,27 +3615,34 @@ export namespace app {
|
|
2939
3615
|
*/
|
2940
3616
|
interface Context {
|
2941
3617
|
/**
|
2942
|
-
*
|
3618
|
+
* Content Action Info
|
3619
|
+
*
|
3620
|
+
* @beta
|
3621
|
+
*/
|
3622
|
+
actionInfo?: ActionInfo;
|
3623
|
+
/**
|
3624
|
+
* Properties about the current session for your app
|
2943
3625
|
*/
|
2944
3626
|
app: AppInfo;
|
2945
3627
|
/**
|
2946
|
-
* Info
|
3628
|
+
* Info about the current page context hosting your app
|
2947
3629
|
*/
|
2948
3630
|
page: PageInfo;
|
2949
3631
|
/**
|
2950
|
-
* Info
|
3632
|
+
* Info about the currently logged in user running the app.
|
3633
|
+
* If the current user is not logged in/authenticated (e.g. a meeting app running for an anonymously-joined partcipant) this will be `undefined`.
|
2951
3634
|
*/
|
2952
3635
|
user?: UserInfo;
|
2953
3636
|
/**
|
2954
|
-
*
|
3637
|
+
* When running in the context of a Teams channel, provides information about the channel, else `undefined`
|
2955
3638
|
*/
|
2956
3639
|
channel?: ChannelInfo;
|
2957
3640
|
/**
|
2958
|
-
*
|
3641
|
+
* When running in the context of a Teams chat, provides information about the chat, else `undefined`
|
2959
3642
|
*/
|
2960
3643
|
chat?: ChatInfo;
|
2961
3644
|
/**
|
2962
|
-
*
|
3645
|
+
* When running in the context of a Teams meeting, provides information about the meeting, else `undefined`
|
2963
3646
|
*/
|
2964
3647
|
meeting?: MeetingInfo;
|
2965
3648
|
/**
|
@@ -2967,11 +3650,13 @@ export namespace app {
|
|
2967
3650
|
*/
|
2968
3651
|
sharepoint?: any;
|
2969
3652
|
/**
|
2970
|
-
*
|
3653
|
+
* When running in Teams for an organization with a tenant, provides information about the SharePoint site associated with the team.
|
3654
|
+
* Will be `undefined` when not running in Teams for an organization with a tenant.
|
2971
3655
|
*/
|
2972
3656
|
sharePointSite?: SharePointSiteInfo;
|
2973
3657
|
/**
|
2974
|
-
*
|
3658
|
+
* When running in Teams, provides information about the Team context in which your app is running.
|
3659
|
+
* Will be `undefined` when not running in Teams.
|
2975
3660
|
*/
|
2976
3661
|
team?: TeamInfo;
|
2977
3662
|
}
|
@@ -2999,20 +3684,18 @@ export namespace app {
|
|
2999
3684
|
function initialize(validMessageOrigins?: string[]): Promise<void>;
|
3000
3685
|
/**
|
3001
3686
|
* @hidden
|
3002
|
-
* Hide from docs.
|
3003
|
-
* ------
|
3004
3687
|
* Undocumented function used to set a mock window for unit tests
|
3005
3688
|
*
|
3006
3689
|
* @internal
|
3690
|
+
* Limited to Microsoft-internal use
|
3007
3691
|
*/
|
3008
3692
|
function _initialize(hostWindow: any): void;
|
3009
3693
|
/**
|
3010
3694
|
* @hidden
|
3011
|
-
* Hide from docs.
|
3012
|
-
* ------
|
3013
3695
|
* Undocumented function used to clear state between unit tests
|
3014
3696
|
*
|
3015
3697
|
* @internal
|
3698
|
+
* Limited to Microsoft-internal use
|
3016
3699
|
*/
|
3017
3700
|
function _uninitialize(): void;
|
3018
3701
|
/**
|
@@ -3218,10 +3901,11 @@ export namespace dialog {
|
|
3218
3901
|
/**
|
3219
3902
|
* @hidden
|
3220
3903
|
* Hide from docs because this function is only used during initialization
|
3221
|
-
*
|
3904
|
+
*
|
3222
3905
|
* Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
|
3223
|
-
* Function is called during app
|
3906
|
+
* Function is called during app initialization
|
3224
3907
|
* @internal
|
3908
|
+
* Limited to Microsoft-internal use
|
3225
3909
|
*/
|
3226
3910
|
function initialize(): void;
|
3227
3911
|
/**
|
@@ -3238,7 +3922,7 @@ export namespace dialog {
|
|
3238
3922
|
*/
|
3239
3923
|
function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
|
3240
3924
|
/**
|
3241
|
-
* Submit the dialog module
|
3925
|
+
* Submit the dialog module and close the dialog
|
3242
3926
|
*
|
3243
3927
|
* @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
|
3244
3928
|
* @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
|
@@ -3314,20 +3998,20 @@ export namespace dialog {
|
|
3314
3998
|
}
|
3315
3999
|
/**
|
3316
4000
|
* @hidden
|
3317
|
-
*
|
3318
|
-
* --------
|
4001
|
+
*
|
3319
4002
|
* Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
|
3320
4003
|
*
|
3321
4004
|
* @internal
|
4005
|
+
* Limited to Microsoft-internal use
|
3322
4006
|
*/
|
3323
4007
|
function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
|
3324
4008
|
/**
|
3325
4009
|
* @hidden
|
3326
|
-
*
|
3327
|
-
* --------
|
4010
|
+
*
|
3328
4011
|
* Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
|
3329
4012
|
*
|
3330
4013
|
* @internal
|
4014
|
+
* Limited to Microsoft-internal use
|
3331
4015
|
*/
|
3332
4016
|
function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
|
3333
4017
|
}
|
@@ -3449,6 +4133,7 @@ export namespace pages {
|
|
3449
4133
|
* @param handler - The handler for placing focus within the application.
|
3450
4134
|
*
|
3451
4135
|
* @internal
|
4136
|
+
* Limited to Microsoft-internal use
|
3452
4137
|
*/
|
3453
4138
|
function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
|
3454
4139
|
/**
|
@@ -3602,9 +4287,10 @@ export namespace pages {
|
|
3602
4287
|
/**
|
3603
4288
|
* @hidden
|
3604
4289
|
* Hide from docs because this function is only used during initialization
|
3605
|
-
*
|
4290
|
+
*
|
3606
4291
|
* Adds register handlers for settings.save and settings.remove upon initialization. Function is called in {@link app.initializeHelper}
|
3607
4292
|
* @internal
|
4293
|
+
* Limited to Microsoft-internal use
|
3608
4294
|
*/
|
3609
4295
|
function initialize(): void;
|
3610
4296
|
/**
|
@@ -3836,21 +4522,33 @@ export namespace menus {
|
|
3836
4522
|
/**
|
3837
4523
|
* @hidden
|
3838
4524
|
* Represents information about item in View Configuration.
|
4525
|
+
*
|
4526
|
+
* @internal
|
4527
|
+
* Limited to Microsoft-internal use
|
3839
4528
|
*/
|
3840
4529
|
interface ViewConfiguration {
|
3841
4530
|
/**
|
3842
4531
|
* @hidden
|
3843
4532
|
* Unique identifier of view.
|
4533
|
+
*
|
4534
|
+
* @internal
|
4535
|
+
* Limited to Microsoft-internal use
|
3844
4536
|
*/
|
3845
4537
|
id: string;
|
3846
4538
|
/**
|
3847
4539
|
* @hidden
|
3848
4540
|
* Display title of the view.
|
4541
|
+
*
|
4542
|
+
* @internal
|
4543
|
+
* Limited to Microsoft-internal use
|
3849
4544
|
*/
|
3850
4545
|
title: string;
|
3851
4546
|
/**
|
3852
4547
|
* @hidden
|
3853
4548
|
* Additional information for accessibility.
|
4549
|
+
*
|
4550
|
+
* @internal
|
4551
|
+
* Limited to Microsoft-internal use
|
3854
4552
|
*/
|
3855
4553
|
contentDescription?: string;
|
3856
4554
|
}
|
@@ -4223,9 +4921,7 @@ export namespace media {
|
|
4223
4921
|
notifyEventToApp(mediaEvent: MediaControllerEvent): void;
|
4224
4922
|
}
|
4225
4923
|
/**
|
4226
|
-
* @
|
4227
|
-
* Hide from docs
|
4228
|
-
* --------
|
4924
|
+
* @beta
|
4229
4925
|
* Events which are used to communicate between the app and the host client during the media recording flow
|
4230
4926
|
*/
|
4231
4927
|
export enum MediaControllerEvent {
|
@@ -4435,10 +5131,10 @@ export namespace location {
|
|
4435
5131
|
export namespace meeting {
|
4436
5132
|
/**
|
4437
5133
|
* @hidden
|
4438
|
-
*
|
4439
|
-
* Data structure to represent a meeting details
|
5134
|
+
* Data structure to represent meeting details
|
4440
5135
|
*
|
4441
5136
|
* @internal
|
5137
|
+
* Limited to Microsoft-internal use
|
4442
5138
|
*/
|
4443
5139
|
interface IMeetingDetailsResponse {
|
4444
5140
|
/**
|
@@ -4504,10 +5200,10 @@ export namespace meeting {
|
|
4504
5200
|
}
|
4505
5201
|
/**
|
4506
5202
|
* @hidden
|
4507
|
-
* Hide from docs
|
4508
5203
|
* Data structure to represent a conversation object.
|
4509
5204
|
*
|
4510
5205
|
* @internal
|
5206
|
+
* Limited to Microsoft-internal use
|
4511
5207
|
*/
|
4512
5208
|
interface IConversation {
|
4513
5209
|
/**
|
@@ -4518,10 +5214,10 @@ export namespace meeting {
|
|
4518
5214
|
}
|
4519
5215
|
/**
|
4520
5216
|
* @hidden
|
4521
|
-
* Hide from docs
|
4522
5217
|
* Data structure to represent an organizer object.
|
4523
5218
|
*
|
4524
5219
|
* @internal
|
5220
|
+
* Limited to Microsoft-internal use
|
4525
5221
|
*/
|
4526
5222
|
interface IOrganizer {
|
4527
5223
|
/**
|
@@ -4562,12 +5258,20 @@ export namespace meeting {
|
|
4562
5258
|
*/
|
4563
5259
|
isAppSharing: boolean;
|
4564
5260
|
}
|
5261
|
+
/**
|
5262
|
+
* Property bag for the speakingState changed event
|
5263
|
+
*
|
5264
|
+
*/
|
4565
5265
|
interface ISpeakingState {
|
4566
5266
|
/**
|
4567
5267
|
* Indicates whether one or more participants in a meeting are speaking, or
|
4568
5268
|
* if no participants are speaking
|
4569
5269
|
*/
|
4570
5270
|
isSpeakingDetected: boolean;
|
5271
|
+
/**
|
5272
|
+
* error object in case there is a failure
|
5273
|
+
*/
|
5274
|
+
error?: SdkError;
|
4571
5275
|
}
|
4572
5276
|
/**
|
4573
5277
|
* Property bag for the meeting reaction received event
|
@@ -4653,8 +5357,6 @@ export namespace meeting {
|
|
4653
5357
|
function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4654
5358
|
/**
|
4655
5359
|
* @hidden
|
4656
|
-
* Hide from docs
|
4657
|
-
*
|
4658
5360
|
* Allows an app to get the meeting details for the meeting
|
4659
5361
|
*
|
4660
5362
|
* @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
|
@@ -4662,6 +5364,7 @@ export namespace meeting {
|
|
4662
5364
|
* result can either contain a IMeetingDetailsResponse value, in case of a successful get or null when the get fails
|
4663
5365
|
*
|
4664
5366
|
* @internal
|
5367
|
+
* Limited to Microsoft-internal use
|
4665
5368
|
*/
|
4666
5369
|
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
4667
5370
|
/**
|
@@ -4673,6 +5376,7 @@ export namespace meeting {
|
|
4673
5376
|
* authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
|
4674
5377
|
*
|
4675
5378
|
* @internal
|
5379
|
+
* Limited to Microsoft-internal use
|
4676
5380
|
*/
|
4677
5381
|
function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
4678
5382
|
/**
|
@@ -4750,9 +5454,9 @@ export namespace meeting {
|
|
4750
5454
|
*/
|
4751
5455
|
function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
|
4752
5456
|
/**
|
4753
|
-
* Registers a handler for changes to paticipant speaking states.
|
4754
|
-
*
|
4755
|
-
* at a time. A subsequent registration replaces an existing registration.
|
5457
|
+
* Registers a handler for changes to paticipant speaking states. This API returns {@link ISpeakingState}, which will have isSpeakingDetected
|
5458
|
+
* and/or an error object. If any participant is speaking, isSpeakingDetected will be true. If no participants are speaking, isSpeakingDetected
|
5459
|
+
* will be false. Default value is false. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
|
4756
5460
|
*
|
4757
5461
|
* @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
|
4758
5462
|
*/
|
@@ -4782,10 +5486,10 @@ export namespace meeting {
|
|
4782
5486
|
export namespace monetization {
|
4783
5487
|
/**
|
4784
5488
|
* @hidden
|
4785
|
-
* Hide from docs
|
4786
5489
|
* Data structure to represent a subscription plan.
|
4787
5490
|
*
|
4788
5491
|
* @internal
|
5492
|
+
* Limited to Microsoft-internal use
|
4789
5493
|
*/
|
4790
5494
|
interface PlanInfo {
|
4791
5495
|
/**
|
@@ -4801,7 +5505,6 @@ export namespace monetization {
|
|
4801
5505
|
}
|
4802
5506
|
/**
|
4803
5507
|
* @hidden
|
4804
|
-
* Hide from docs
|
4805
5508
|
* Open dialog to start user's purchase experience
|
4806
5509
|
*
|
4807
5510
|
* @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
|
@@ -4809,6 +5512,7 @@ export namespace monetization {
|
|
4809
5512
|
* @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
|
4810
5513
|
*
|
4811
5514
|
* @internal
|
5515
|
+
* Limited to Microsoft-internal use
|
4812
5516
|
*/
|
4813
5517
|
function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
|
4814
5518
|
/**
|
@@ -4816,7 +5520,6 @@ export namespace monetization {
|
|
4816
5520
|
* As of 2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
|
4817
5521
|
*
|
4818
5522
|
* @hidden
|
4819
|
-
* Hide from docs
|
4820
5523
|
* Open dialog to start user's purchase experience
|
4821
5524
|
*
|
4822
5525
|
* @param callback Callback contains 1 parameters, error.
|
@@ -4824,6 +5527,7 @@ export namespace monetization {
|
|
4824
5527
|
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
4825
5528
|
*
|
4826
5529
|
* @internal
|
5530
|
+
* Limited to Microsoft-internal use
|
4827
5531
|
*/
|
4828
5532
|
function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
|
4829
5533
|
function isSupported(): boolean;
|
@@ -5426,11 +6130,10 @@ export function initialize(callback?: () => void, validMessageOrigins?: string[]
|
|
5426
6130
|
* As of 2.0.0, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
|
5427
6131
|
*
|
5428
6132
|
* @hidden
|
5429
|
-
* Hide from docs.
|
5430
|
-
* ------
|
5431
6133
|
* Undocumented function used to set a mock window for unit tests
|
5432
6134
|
*
|
5433
6135
|
* @internal
|
6136
|
+
* Limited to Microsoft-internal use
|
5434
6137
|
*/
|
5435
6138
|
export function _initialize(hostWindow: any): void;
|
5436
6139
|
/**
|
@@ -5438,11 +6141,10 @@ export function _initialize(hostWindow: any): void;
|
|
5438
6141
|
* As of 2.0.0, please use {@link app._uninitialize app._uninitialize(): void} instead.
|
5439
6142
|
*
|
5440
6143
|
* @hidden
|
5441
|
-
* Hide from docs.
|
5442
|
-
* ------
|
5443
6144
|
* Undocumented function used to clear state between unit tests
|
5444
6145
|
*
|
5445
6146
|
* @internal
|
6147
|
+
* Limited to Microsoft-internal use
|
5446
6148
|
*/
|
5447
6149
|
export function _uninitialize(): void;
|
5448
6150
|
/**
|
@@ -5622,7 +6324,7 @@ export function setFrameContext(frameContext: FrameContext): void;
|
|
5622
6324
|
* @deprecated
|
5623
6325
|
* As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
|
5624
6326
|
*
|
5625
|
-
*
|
6327
|
+
* Initialize with FrameContext
|
5626
6328
|
*
|
5627
6329
|
* @param frameContext - FrameContext information to be set
|
5628
6330
|
* @param callback - The optional callback to be invoked be invoked after initilizing the frame context
|
@@ -5820,7 +6522,7 @@ export namespace tasks {
|
|
5820
6522
|
function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
|
5821
6523
|
/**
|
5822
6524
|
* Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
|
5823
|
-
* otherwise uses the height and width values corresponding to {@link TaskModuleDimension.Small}
|
6525
|
+
* otherwise uses the height and width values corresponding to {@link TaskModuleDimension | TaskModuleDimension.Small}
|
5824
6526
|
* @param taskInfo TaskInfo object from which to extract size info, if specified
|
5825
6527
|
* @returns TaskInfo with height and width specified
|
5826
6528
|
*/
|