@microsoft/teams-js 2.2.0 → 2.3.0-beta.1

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.
@@ -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
- * Hide from docs
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
- * Hide from docs
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
- * Hide from docs
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
- * Hide from docs.
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
- * Hide from docs.
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
- * Hide from docs.
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
- * Hide from docs
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
- * Hide from docs
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
- * Hide from docs
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
- * Hide from docs
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
- * Hide from docs
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,42 +828,76 @@ 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
  }
648
895
  /**
896
+ * @hidden
649
897
  * Object used to represent a file
898
+ *
899
+ * @internal
900
+ * Limited to Microsoft-internal use
650
901
  */
651
902
  export interface File extends Blob {
652
903
  /**
@@ -667,6 +918,9 @@ export namespace files {
667
918
  * Hide from docs
668
919
  *
669
920
  * Actions specific to 3P cloud storage provider file and / or account
921
+ *
922
+ * @internal
923
+ * Limited to Microsoft-internal use
670
924
  */
671
925
  export enum CloudStorageProviderFileAction {
672
926
  Download = "DOWNLOAD",
@@ -678,6 +932,9 @@ export namespace files {
678
932
  * Hide from docs
679
933
  *
680
934
  * Interface for 3P cloud storage provider request content type
935
+ *
936
+ * @internal
937
+ * Limited to Microsoft-internal use
681
938
  */
682
939
  export interface CloudStorageProviderRequest<T> {
683
940
  content: T;
@@ -687,6 +944,9 @@ export namespace files {
687
944
  * Hide from docs
688
945
  *
689
946
  * Base interface for 3P cloud storage provider action request content
947
+ *
948
+ * @internal
949
+ * Limited to Microsoft-internal use
690
950
  */
691
951
  export interface CloudStorageProviderContent {
692
952
  providerCode: CloudStorageProvider;
@@ -697,6 +957,9 @@ export namespace files {
697
957
  *
698
958
  * Interface representing 3P cloud storage provider add new file action.
699
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
700
963
  */
701
964
  export interface CloudStorageProviderNewFileContent extends CloudStorageProviderContent {
702
965
  newFileName: string;
@@ -708,6 +971,9 @@ export namespace files {
708
971
  * Hide from docs
709
972
  *
710
973
  * Interface representing 3P cloud storage provider rename existing file action
974
+ *
975
+ * @internal
976
+ * Limited to Microsoft-internal use
711
977
  */
712
978
  export interface CloudStorageProviderRenameFileContent extends CloudStorageProviderContent {
713
979
  existingFile: CloudStorageFolderItem | ISharePointFile;
@@ -718,6 +984,9 @@ export namespace files {
718
984
  * Hide from docs
719
985
  *
720
986
  * Interface representing 3P cloud storage provider delete existing file(s) action
987
+ *
988
+ * @internal
989
+ * Limited to Microsoft-internal use
721
990
  */
722
991
  export interface CloudStorageProviderDeleteFileContent extends CloudStorageProviderContent {
723
992
  itemList: CloudStorageFolderItem[] | ISharePointFile[];
@@ -727,6 +996,9 @@ export namespace files {
727
996
  * Hide from docs
728
997
  *
729
998
  * Interface representing 3P cloud storage provider download existing file(s) action
999
+ *
1000
+ * @internal
1001
+ * Limited to Microsoft-internal use
730
1002
  */
731
1003
  export interface CloudStorageProviderDownloadFileContent extends CloudStorageProviderContent {
732
1004
  itemList: CloudStorageFolderItem[] | ISharePointFile[];
@@ -736,6 +1008,9 @@ export namespace files {
736
1008
  * Hide from docs
737
1009
  *
738
1010
  * Interface representing 3P cloud storage provider upload existing file(s) action
1011
+ *
1012
+ * @internal
1013
+ * Limited to Microsoft-internal use
739
1014
  */
740
1015
  export interface CloudStorageProviderUploadFileContent extends CloudStorageProviderContent {
741
1016
  itemList: File[];
@@ -748,6 +1023,9 @@ export namespace files {
748
1023
  * Gets a list of cloud storage folders added to the channel
749
1024
  * @param channelId - ID of the channel whose cloud storage folders should be retrieved
750
1025
  * @param callback - Callback that will be triggered post folders load
1026
+ *
1027
+ * @internal
1028
+ * Limited to Microsoft-internal use
751
1029
  */
752
1030
  export function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
753
1031
  /**
@@ -758,6 +1036,9 @@ export namespace files {
758
1036
  *
759
1037
  * @param channelId - ID of the channel to add cloud storage folder
760
1038
  * @param callback - Callback that will be triggered post add folder flow is compelete
1039
+ *
1040
+ * @internal
1041
+ * Limited to Microsoft-internal use
761
1042
  */
762
1043
  export function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
763
1044
  /**
@@ -770,6 +1051,9 @@ export namespace files {
770
1051
  * @param channelId - ID of the channel where folder is to be deleted
771
1052
  * @param folderToDelete - cloud storage folder to be deleted
772
1053
  * @param callback - Callback that will be triggered post delete
1054
+ *
1055
+ * @internal
1056
+ * Limited to Microsoft-internal use
773
1057
  */
774
1058
  export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
775
1059
  /**
@@ -782,6 +1066,9 @@ export namespace files {
782
1066
  * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
783
1067
  * @param providerCode - Code of the cloud storage folder provider
784
1068
  * @param callback - Callback that will be triggered post contents are loaded
1069
+ *
1070
+ * @internal
1071
+ * Limited to Microsoft-internal use
785
1072
  */
786
1073
  export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
787
1074
  /**
@@ -794,6 +1081,9 @@ export namespace files {
794
1081
  * @param file - cloud storage file that should be opened
795
1082
  * @param providerCode - Code of the cloud storage folder provider
796
1083
  * @param fileOpenPreference - Whether file should be opened in web/inline
1084
+ *
1085
+ * @internal
1086
+ * Limited to Microsoft-internal use
797
1087
  */
798
1088
  export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
799
1089
  /**
@@ -802,12 +1092,18 @@ export namespace files {
802
1092
  * third party cloud storage accounts that the tenant supports
803
1093
  * @param excludeAddedProviders: return a list of support third party
804
1094
  * cloud storages that hasn't been added yet.
1095
+ *
1096
+ * @internal
1097
+ * Limited to Microsoft-internal use
805
1098
  */
806
1099
  export function getExternalProviders(excludeAddedProviders: boolean, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
807
1100
  /**
808
1101
  * @hidden
809
1102
  * Allow 1st party apps to call this function to move files
810
1103
  * among SharePoint and third party cloud storages.
1104
+ *
1105
+ * @internal
1106
+ * Limited to Microsoft-internal use
811
1107
  */
812
1108
  export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean, callback: (error?: SdkError) => void): void;
813
1109
  /**
@@ -817,6 +1113,9 @@ export namespace files {
817
1113
  *
818
1114
  * Gets list of downloads for current user
819
1115
  * @param callback Callback that will be triggered post downloads load
1116
+ *
1117
+ * @internal
1118
+ * Limited to Microsoft-internal use
820
1119
  */
821
1120
  export function getFileDownloads(callback: (error?: SdkError, files?: IFileItem[]) => void): void;
822
1121
  /**
@@ -826,6 +1125,9 @@ export namespace files {
826
1125
  * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
827
1126
  * @param fileObjectId - Id of the file whose containing folder should be opened
828
1127
  * @param callback Callback that will be triggered post open download folder/path
1128
+ *
1129
+ * @internal
1130
+ * Limited to Microsoft-internal use
829
1131
  */
830
1132
  export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;
831
1133
  /**
@@ -837,6 +1139,9 @@ export namespace files {
837
1139
  * for selected 3P provider is performed on success of which the selected 3P provider support is added for user
838
1140
  *
839
1141
  * @param callback Callback that will be triggered post add 3P cloud storage provider action
1142
+ *
1143
+ * @internal
1144
+ * Limited to Microsoft-internal use
840
1145
  */
841
1146
  export function addCloudStorageProvider(callback: (error?: SdkError) => void): void;
842
1147
  /**
@@ -849,6 +1154,9 @@ export namespace files {
849
1154
  *
850
1155
  * @param logoutRequest 3P cloud storage provider remove action request content
851
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
852
1160
  */
853
1161
  export function removeCloudStorageProvider(logoutRequest: CloudStorageProviderRequest<CloudStorageProviderContent>, callback: (error?: SdkError) => void): void;
854
1162
  /**
@@ -859,6 +1167,9 @@ export namespace files {
859
1167
  *
860
1168
  * @param addNewFileRequest 3P cloud storage provider add action request content
861
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
862
1173
  */
863
1174
  export function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
864
1175
  /**
@@ -869,6 +1180,9 @@ export namespace files {
869
1180
  *
870
1181
  * @param renameFileRequest 3P cloud storage provider rename action request content
871
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
872
1186
  */
873
1187
  export function renameCloudStorageProviderFile(renameFileRequest: CloudStorageProviderRequest<CloudStorageProviderRenameFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
874
1188
  /**
@@ -880,6 +1194,9 @@ export namespace files {
880
1194
  *
881
1195
  * @param deleteFileRequest 3P cloud storage provider delete action request content
882
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
883
1200
  */
884
1201
  export function deleteCloudStorageProviderFile(deleteFileRequest: CloudStorageProviderRequest<CloudStorageProviderDeleteFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
885
1202
  /**
@@ -891,6 +1208,9 @@ export namespace files {
891
1208
  *
892
1209
  * @param downloadFileRequest 3P cloud storage provider download file(s) action request content
893
1210
  * @param callback Callback that will be triggered post downloading existing file(s) flow is finished
1211
+ *
1212
+ * @internal
1213
+ * Limited to Microsoft-internal use
894
1214
  */
895
1215
  export function downloadCloudStorageProviderFile(downloadFileRequest: CloudStorageProviderRequest<CloudStorageProviderDownloadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
896
1216
  /**
@@ -901,6 +1221,9 @@ export namespace files {
901
1221
  *
902
1222
  * @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
903
1223
  * @param callback Callback that will be triggered post uploading file(s) flow is finished
1224
+ *
1225
+ * @internal
1226
+ * Limited to Microsoft-internal use
904
1227
  */
905
1228
  export function uploadCloudStorageProviderFile(uploadFileRequest: CloudStorageProviderRequest<CloudStorageProviderUploadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
906
1229
  /**
@@ -912,6 +1235,7 @@ export namespace files {
912
1235
  *
913
1236
  * @param handler - When 3P cloud storage provider list is updated this handler is called
914
1237
  *
1238
+ * @internal Limited to Microsoft-internal use
915
1239
  */
916
1240
  export function registerCloudStorageProviderListChangeHandler(handler: () => void): void;
917
1241
  /**
@@ -923,151 +1247,194 @@ export namespace files {
923
1247
  *
924
1248
  * @param handler - When 3P cloud storage provider content is updated this handler is called
925
1249
  *
1250
+ * @internal
1251
+ * Limited to Microsoft-internal use
926
1252
  */
927
1253
  export function registerCloudStorageProviderContentChangeHandler(handler: () => void): void;
928
1254
  export {};
929
1255
  }
930
1256
 
1257
+ /**
1258
+ * @hidden
1259
+ *
1260
+ * @internal
1261
+ * Limited to Microsoft-internal use
1262
+ */
931
1263
  export namespace meetingRoom {
932
1264
  /**
933
1265
  * @hidden
934
- * Hide from docs
935
- * ------
1266
+ *
936
1267
  * Data structure to represent a meeting room.
1268
+ *
1269
+ * @internal
1270
+ * Limited to Microsoft-internal use
937
1271
  */
938
1272
  export interface MeetingRoomInfo {
939
1273
  /**
940
1274
  * @hidden
941
1275
  * Endpoint id of the meeting room.
1276
+ *
1277
+ * @internal
1278
+ * Limited to Microsoft-internal use
942
1279
  */
943
1280
  endpointId: string;
944
1281
  /**
945
1282
  * @hidden
946
1283
  * Device name of the meeting room.
1284
+ *
1285
+ * @internal
1286
+ * Limited to Microsoft-internal use
947
1287
  */
948
1288
  deviceName: string;
949
1289
  /**
950
1290
  * @hidden
951
1291
  * Client type of the meeting room.
1292
+ *
1293
+ * @internal
1294
+ * Limited to Microsoft-internal use
952
1295
  */
953
1296
  clientType: string;
954
1297
  /**
955
1298
  * @hidden
956
1299
  * Client version of the meeting room.
1300
+ *
1301
+ * @internal
1302
+ * Limited to Microsoft-internal use
957
1303
  */
958
1304
  clientVersion: string;
959
1305
  }
960
1306
  /**
961
1307
  * @hidden
962
- * Hide from docs
963
- * ------
964
1308
  * Type of Media control capabilities of a meeting room.
965
1309
  */
966
1310
  type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
967
1311
  /**
968
1312
  * @hidden
969
- * Hide from docs
970
- * ------
971
1313
  * Types of Stage Layout control capabilities of a meeting room.
972
1314
  */
973
1315
  type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
974
1316
  /**
975
1317
  * @hidden
976
- * Hide from docs
977
- * ------
978
1318
  * Types of Meeting Control capabilities of a meeting room.
979
1319
  */
980
1320
  type MeetingControls = 'leaveMeeting';
981
1321
  /**
982
1322
  * @hidden
983
- * Hide from docs
984
- * ------
985
1323
  * Types of Stage Layout State of a meeting room.
986
1324
  */
987
1325
  type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
988
1326
  /**
989
1327
  * @hidden
990
- * Hide from docs
991
- * ------
992
1328
  * Data structure to represent capabilities of a meeting room.
1329
+ *
1330
+ * @internal
1331
+ * Limited to Microsoft-internal use
993
1332
  */
994
1333
  export interface MeetingRoomCapability {
995
1334
  /**
996
1335
  * @hidden
997
1336
  * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
1337
+ *
1338
+ * @internal
1339
+ * Limited to Microsoft-internal use
998
1340
  */
999
1341
  mediaControls: MediaControls[];
1000
1342
  /**
1001
1343
  * @hidden
1002
1344
  * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
1345
+ *
1346
+ * @internal
1347
+ * Limited to Microsoft-internal use
1003
1348
  */
1004
1349
  stageLayoutControls: StageLayoutControls[];
1005
1350
  /**
1006
1351
  * @hidden
1007
1352
  * Meeting control capabilities, value can be "leaveMeeting".
1353
+ *
1354
+ * @internal
1355
+ * Limited to Microsoft-internal use
1008
1356
  */
1009
1357
  meetingControls: MeetingControls[];
1010
1358
  }
1011
1359
  /**
1012
1360
  * @hidden
1013
- * Hide from docs
1014
- * ------
1015
1361
  * Data structure to represent states of a meeting room.
1362
+ *
1363
+ * @internal
1364
+ * Limited to Microsoft-internal use
1016
1365
  */
1017
1366
  export interface MeetingRoomState {
1018
1367
  /**
1019
1368
  * @hidden
1020
1369
  * Current mute state, true: mute, false: unmute.
1370
+ *
1371
+ * @internal
1372
+ * Limited to Microsoft-internal use
1021
1373
  */
1022
1374
  toggleMute: boolean;
1023
1375
  /**
1024
1376
  * @hidden
1025
1377
  * Current camera state, true: camera on, false: camera off.
1378
+ *
1379
+ * @internal
1380
+ * Limited to Microsoft-internal use
1026
1381
  */
1027
1382
  toggleCamera: boolean;
1028
1383
  /**
1029
1384
  * @hidden
1030
1385
  * Current captions state, true: captions on, false: captions off.
1386
+ *
1387
+ * @internal
1388
+ * Limited to Microsoft-internal use
1031
1389
  */
1032
1390
  toggleCaptions: boolean;
1033
1391
  /**
1034
1392
  * @hidden
1035
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
1036
1397
  */
1037
1398
  stageLayout: StageLayoutStates;
1038
1399
  /**
1039
1400
  * @hidden
1040
1401
  * Current leaveMeeting state, true: leave, false: no-op.
1402
+ *
1403
+ * @internal
1404
+ * Limited to Microsoft-internal use
1041
1405
  */
1042
1406
  leaveMeeting: boolean;
1043
1407
  }
1044
1408
  /**
1045
1409
  * @hidden
1046
- * Hide from docs
1047
- * ------
1048
1410
  * Fetch the meeting room info that paired with current client.
1049
1411
  *
1050
1412
  * @returns Promise resolved with meeting room info or rejected with SdkError value
1413
+ *
1414
+ * @internal
1415
+ * Limited to Microsoft-internal use
1051
1416
  */
1052
1417
  export function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
1053
1418
  /**
1054
1419
  * @hidden
1055
- * Hide from docs
1056
- * ------
1057
1420
  * Send a command to paired meeting room.
1058
1421
  *
1059
1422
  * @param commandName The command name.
1060
1423
  * @returns Promise resolved upon completion or rejected with SdkError value
1424
+ *
1425
+ * @internal
1426
+ * Limited to Microsoft-internal use
1061
1427
  */
1062
1428
  export function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
1063
1429
  /**
1064
1430
  * @hidden
1065
- * Hide from docs
1066
- * ------
1067
1431
  * Registers a handler for meeting room capabilities update.
1068
1432
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
1069
1433
  *
1070
1434
  * @param handler The handler to invoke when the capabilities of meeting room update.
1435
+ *
1436
+ * @internal
1437
+ * Limited to Microsoft-internal use
1071
1438
  */
1072
1439
  export function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
1073
1440
  /**
@@ -1077,57 +1444,91 @@ export namespace meetingRoom {
1077
1444
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
1078
1445
  *
1079
1446
  * @param handler The handler to invoke when the states of meeting room update.
1447
+ *
1448
+ * @internal
1449
+ * Limited to Microsoft-internal use
1450
+ */
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
1080
1459
  */
1081
- export function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
1082
1460
  export function isSupported(): boolean;
1083
1461
  export {};
1084
1462
  }
1085
1463
 
1086
1464
  export namespace notifications {
1087
- /**
1088
- * @hidden
1089
- * Hide from docs.
1090
- * ------
1091
- * display notification API.
1092
- *
1093
- * @param message - Notification message.
1094
- * @param notificationType - Notification type
1095
- *
1096
- * @internal
1097
- */
1098
- function showNotification(showNotificationParameters: ShowNotificationParameters): void;
1099
- function isSupported(): boolean;
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;
1100
1484
  }
1101
1485
 
1486
+ /**
1487
+ * @hidden
1488
+ *
1489
+ * @internal
1490
+ * Limited to Microsoft-internal use
1491
+ */
1102
1492
  export namespace remoteCamera {
1103
1493
  /**
1104
1494
  * @hidden
1105
- * Hide from docs
1106
- * ------
1107
1495
  * Data structure to represent patricipant details needed to request control of camera.
1496
+ *
1497
+ * @internal
1498
+ * Limited to Microsoft-internal use
1108
1499
  */
1109
1500
  interface Participant {
1110
1501
  /**
1111
1502
  * @hidden
1112
1503
  * Id of participant.
1504
+ *
1505
+ * @internal
1506
+ * Limited to Microsoft-internal use
1113
1507
  */
1114
1508
  id: string;
1115
1509
  /**
1116
1510
  * @hidden
1117
1511
  * Display name of participant.
1512
+ *
1513
+ * @internal
1514
+ * Limited to Microsoft-internal use
1118
1515
  */
1119
1516
  displayName?: string;
1120
1517
  /**
1121
1518
  * @hidden
1122
1519
  * Active indicates whether the participant's device is actively being controlled.
1520
+ *
1521
+ * @internal
1522
+ * Limited to Microsoft-internal use
1123
1523
  */
1124
1524
  active?: boolean;
1125
1525
  }
1126
1526
  /**
1127
1527
  * @hidden
1128
- * Hide from docs
1129
- * ------
1130
1528
  * Enum used to indicate possible camera control commands.
1529
+ *
1530
+ * @internal
1531
+ * Limited to Microsoft-internal use
1131
1532
  */
1132
1533
  enum ControlCommand {
1133
1534
  Reset = "Reset",
@@ -1140,62 +1541,90 @@ export namespace remoteCamera {
1140
1541
  }
1141
1542
  /**
1142
1543
  * @hidden
1143
- * Hide from docs
1144
- * ------
1145
1544
  * Data structure to indicate the current state of the device.
1545
+ *
1546
+ * @internal
1547
+ * Limited to Microsoft-internal use
1146
1548
  */
1147
1549
  interface DeviceState {
1148
1550
  /**
1149
1551
  * @hidden
1150
1552
  * All operation are available to apply.
1553
+ *
1554
+ * @internal
1555
+ * Limited to Microsoft-internal use
1151
1556
  */
1152
1557
  available: boolean;
1153
1558
  /**
1154
1559
  * @hidden
1155
1560
  * Either camera doesnt support to get state or It unable to apply command.
1561
+ *
1562
+ * @internal
1563
+ * Limited to Microsoft-internal use
1156
1564
  */
1157
1565
  error: boolean;
1158
1566
  /**
1159
1567
  * @hidden
1160
1568
  * Reset max out or already applied. Client Disable Reset.
1569
+ *
1570
+ * @internal
1571
+ * Limited to Microsoft-internal use
1161
1572
  */
1162
1573
  reset: boolean;
1163
1574
  /**
1164
1575
  * @hidden
1165
1576
  * ZoomIn maxed out.
1577
+ *
1578
+ * @internal
1579
+ * Limited to Microsoft-internal use
1166
1580
  */
1167
1581
  zoomIn: boolean;
1168
1582
  /**
1169
1583
  * @hidden
1170
1584
  * ZoomOut maxed out.
1585
+ *
1586
+ * @internal
1587
+ * Limited to Microsoft-internal use
1171
1588
  */
1172
1589
  zoomOut: boolean;
1173
1590
  /**
1174
1591
  * @hidden
1175
1592
  * PanLeft reached max left.
1593
+ *
1594
+ * @internal
1595
+ * Limited to Microsoft-internal use
1176
1596
  */
1177
1597
  panLeft: boolean;
1178
1598
  /**
1179
1599
  * @hidden
1180
1600
  * PanRight reached max right.
1601
+ *
1602
+ * @internal
1603
+ * Limited to Microsoft-internal use
1181
1604
  */
1182
1605
  panRight: boolean;
1183
1606
  /**
1184
1607
  * @hidden
1185
1608
  * TiltUp reached top.
1609
+ *
1610
+ * @internal
1611
+ * Limited to Microsoft-internal use
1186
1612
  */
1187
1613
  tiltUp: boolean;
1188
1614
  /**
1189
1615
  * @hidden
1190
1616
  * TiltDown reached bottom.
1617
+ *
1618
+ * @internal Limited to Microsoft-internal use
1191
1619
  */
1192
1620
  tiltDown: boolean;
1193
1621
  }
1194
1622
  /**
1195
1623
  * @hidden
1196
- * Hide from docs
1197
- * ------
1198
1624
  * Enum used to indicate the reason for the error.
1625
+ *
1626
+ * @internal
1627
+ * Limited to Microsoft-internal use
1199
1628
  */
1200
1629
  enum ErrorReason {
1201
1630
  CommandResetError = 0,
@@ -1209,27 +1638,35 @@ export namespace remoteCamera {
1209
1638
  }
1210
1639
  /**
1211
1640
  * @hidden
1212
- * Hide from docs
1213
- * ------
1214
1641
  * Data structure to indicate the status of the current session.
1642
+ *
1643
+ * @internal
1644
+ * Limited to Microsoft-internal use
1215
1645
  */
1216
1646
  interface SessionStatus {
1217
1647
  /**
1218
1648
  * @hidden
1219
1649
  * Whether the far-end user is controlling a device.
1650
+ *
1651
+ * @internal
1652
+ * Limited to Microsoft-internal use
1220
1653
  */
1221
1654
  inControl: boolean;
1222
1655
  /**
1223
1656
  * @hidden
1224
1657
  * Reason the control session was terminated.
1658
+ *
1659
+ * @internal
1660
+ * Limited to Microsoft-internal use
1225
1661
  */
1226
1662
  terminatedReason?: SessionTerminatedReason;
1227
1663
  }
1228
1664
  /**
1229
1665
  * @hidden
1230
- * Hide from docs
1231
- * ------
1232
1666
  * Enum used to indicate the reason the session was terminated.
1667
+ *
1668
+ * @internal
1669
+ * Limited to Microsoft-internal use
1233
1670
  */
1234
1671
  enum SessionTerminatedReason {
1235
1672
  None = 0,
@@ -1246,20 +1683,19 @@ export namespace remoteCamera {
1246
1683
  }
1247
1684
  /**
1248
1685
  * @hidden
1249
- * Hide from docs
1250
- * ------
1251
1686
  * Fetch a list of the participants with controllable-cameras in a meeting.
1252
1687
  *
1253
1688
  * @param callback - Callback contains 2 parameters, error and participants.
1254
1689
  * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
1255
1690
  * participants can either contain an array of Participant objects, incase of a successful fetch or null when it fails
1256
1691
  * participants: object that contains an array of participants with controllable-cameras
1692
+ *
1693
+ * @internal
1694
+ * Limited to Microsoft-internal use
1257
1695
  */
1258
1696
  function getCapableParticipants(callback: (error: SdkError | null, participants: Participant[] | null) => void): void;
1259
1697
  /**
1260
1698
  * @hidden
1261
- * Hide from docs
1262
- * ------
1263
1699
  * Request control of a participant's camera.
1264
1700
  *
1265
1701
  * @param participant - Participant specifies the participant to send the request for camera control.
@@ -1267,25 +1703,30 @@ export namespace remoteCamera {
1267
1703
  * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
1268
1704
  * requestResponse can either contain the true/false value, incase of a successful request or null when it fails
1269
1705
  * requestResponse: True means request was accepted and false means request was denied
1706
+ *
1707
+ * @internal
1708
+ * Limited to Microsoft-internal use
1270
1709
  */
1271
1710
  function requestControl(participant: Participant, callback: (error: SdkError | null, requestResponse: boolean | null) => void): void;
1272
1711
  /**
1273
1712
  * @hidden
1274
- * Hide from docs
1275
- * ------
1276
1713
  * Send control command to the participant's camera.
1277
1714
  *
1278
1715
  * @param ControlCommand - ControlCommand specifies the command for controling the camera.
1279
1716
  * @param callback - Callback to invoke when the command response returns.
1717
+ *
1718
+ * @internal
1719
+ * Limited to Microsoft-internal use
1280
1720
  */
1281
1721
  function sendControlCommand(ControlCommand: ControlCommand, callback: (error: SdkError | null) => void): void;
1282
1722
  /**
1283
1723
  * @hidden
1284
- * Hide from docs
1285
- * ------
1286
1724
  * Terminate the remote session
1287
1725
  *
1288
1726
  * @param callback - Callback to invoke when the command response returns.
1727
+ *
1728
+ * @internal
1729
+ * Limited to Microsoft-internal use
1289
1730
  */
1290
1731
  function terminateSession(callback: (error: SdkError | null) => void): void;
1291
1732
  /**
@@ -1294,6 +1735,9 @@ export namespace remoteCamera {
1294
1735
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
1295
1736
  *
1296
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
1297
1741
  */
1298
1742
  function registerOnCapableParticipantsChangeHandler(handler: (participantChange: Participant[]) => void): void;
1299
1743
  /**
@@ -1302,6 +1746,9 @@ export namespace remoteCamera {
1302
1746
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
1303
1747
  *
1304
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
1305
1752
  */
1306
1753
  function registerOnErrorHandler(handler: (error: ErrorReason) => void): void;
1307
1754
  /**
@@ -1310,6 +1757,9 @@ export namespace remoteCamera {
1310
1757
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
1311
1758
  *
1312
1759
  * @param handler - The handler to invoke when the controlled device changes state.
1760
+ *
1761
+ * @internal
1762
+ * Limited to Microsoft-internal use
1313
1763
  */
1314
1764
  function registerOnDeviceStateChangeHandler(handler: (deviceStateChange: DeviceState) => void): void;
1315
1765
  /**
@@ -1318,46 +1768,76 @@ export namespace remoteCamera {
1318
1768
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
1319
1769
  *
1320
1770
  * @param handler - The handler to invoke when the current session status changes.
1771
+ *
1772
+ * @internal
1773
+ * Limited to Microsoft-internal use
1321
1774
  */
1322
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
+ */
1323
1783
  function isSupported(): boolean;
1324
1784
  }
1325
1785
 
1326
1786
  /**
1327
1787
  * @hidden
1328
1788
  * Namespace to interact with the application entities specific part of the SDK.
1789
+ *
1790
+ * @internal
1791
+ * Limited to Microsoft-internal use
1329
1792
  */
1330
1793
  export namespace appEntity {
1331
1794
  /**
1332
1795
  * @hidden
1333
- * Hide from docs
1334
- * --------
1796
+ *
1335
1797
  * Information on an app entity
1798
+ *
1799
+ * @internal
1800
+ * Limited to Microsoft-internal use
1336
1801
  */
1337
1802
  interface AppEntity {
1338
1803
  /**
1339
1804
  * @hidden
1340
1805
  * ID of the application
1806
+ *
1807
+ * @internal
1808
+ * Limited to Microsoft-internal use
1341
1809
  */
1342
1810
  appId: string;
1343
1811
  /**
1344
1812
  * @hidden
1345
1813
  * URL for the application's icon
1814
+ *
1815
+ * @internal
1816
+ * Limited to Microsoft-internal use
1346
1817
  */
1347
1818
  appIconUrl: string;
1348
1819
  /**
1349
1820
  * @hidden
1350
1821
  * Content URL for the app entity
1822
+ *
1823
+ * @internal
1824
+ * Limited to Microsoft-internal use
1351
1825
  */
1352
1826
  contentUrl: string;
1353
1827
  /**
1354
1828
  * @hidden
1355
1829
  * The display name for the app entity
1830
+ *
1831
+ * @internal
1832
+ * Limited to Microsoft-internal use
1356
1833
  */
1357
1834
  displayName: string;
1358
1835
  /**
1359
1836
  * @hidden
1360
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
1361
1841
  */
1362
1842
  websiteUrl: string;
1363
1843
  }
@@ -1373,12 +1853,20 @@ export namespace appEntity {
1373
1853
  * @param callback Callback that will be triggered once the app entity information is available.
1374
1854
  * The callback takes two arguments: an SdkError in case something happened (i.e.
1375
1855
  * no permissions to execute the API) and the app entity configuration, if available
1856
+ *
1857
+ * @internal
1858
+ * Limited to Microsoft-internal use
1376
1859
  */
1377
1860
  function selectAppEntity(threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void): void;
1378
1861
  /**
1862
+ * @hidden
1863
+ *
1379
1864
  * Checks if appEntity capability is supported by the host
1380
1865
  * @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
1381
1866
  * false if it is disabled
1867
+ *
1868
+ * @internal
1869
+ * Limited to Microsoft-internal use
1382
1870
  */
1383
1871
  function isSupported(): boolean;
1384
1872
  }
@@ -1386,10 +1874,9 @@ export namespace appEntity {
1386
1874
  /**
1387
1875
  * @hidden
1388
1876
  * Namespace to interact with the `teams` specific part of the SDK.
1389
- * ------
1390
- * Hide from docs
1391
1877
  *
1392
1878
  * @internal
1879
+ * Limited to Microsoft-internal use
1393
1880
  */
1394
1881
  export namespace teams {
1395
1882
  enum ChannelType {
@@ -1397,6 +1884,12 @@ export namespace teams {
1397
1884
  Private = 1,
1398
1885
  Shared = 2
1399
1886
  }
1887
+ /**
1888
+ * @hidden
1889
+ *
1890
+ * @internal
1891
+ * Limited to Microsoft-internal use
1892
+ */
1400
1893
  interface ChannelInfo {
1401
1894
  siteUrl: string;
1402
1895
  objectId: string;
@@ -1406,11 +1899,12 @@ export namespace teams {
1406
1899
  }
1407
1900
  /**
1408
1901
  * @hidden
1409
- * Hide from docs
1410
- * ------
1411
1902
  * Get a list of channels belong to a Team
1412
1903
  *
1413
1904
  * @param groupId - a team's objectId
1905
+ *
1906
+ * @internal
1907
+ * Limited to Microsoft-internal use
1414
1908
  */
1415
1909
  function getTeamChannels(groupId: string, callback: (error: SdkError, channels: ChannelInfo[]) => void): void;
1416
1910
  /**
@@ -1420,6 +1914,9 @@ export namespace teams {
1420
1914
  *
1421
1915
  * @param threadId - ID of the thread where the app entity will be created; if threadId is not
1422
1916
  * provided, the threadId from route params will be used.
1917
+ *
1918
+ * @internal
1919
+ * Limited to Microsoft-internal use
1423
1920
  */
1424
1921
  function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
1425
1922
  /**
@@ -1428,55 +1925,65 @@ export namespace teams {
1428
1925
  *
1429
1926
  * @returns true if the teams capability is enabled in runtime.supports.teams and
1430
1927
  * false if it is disabled
1928
+ *
1929
+ * @internal
1930
+ * Limited to Microsoft-internal use
1431
1931
  */
1432
1932
  function isSupported(): boolean;
1433
1933
  /**
1434
1934
  * @hidden
1435
- * Hide from docs
1436
- * ------
1437
- *
1438
1935
  * @internal
1936
+ * Limited to Microsoft-internal use
1439
1937
  */
1440
1938
  namespace fullTrust {
1939
+ /**
1940
+ * @hidden
1941
+ * @internal
1942
+ * Limited to Microsoft-internal use
1943
+ */
1441
1944
  namespace joinedTeams {
1442
1945
  /**
1443
1946
  * @hidden
1444
- * Hide from docs
1445
- * ------
1446
1947
  * Allows an app to retrieve information of all user joined teams
1447
1948
  *
1448
1949
  * @param teamInstanceParameters - Optional flags that specify whether to scope call to favorite teams
1449
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
1450
1954
  */
1451
1955
  function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
1452
1956
  /**
1453
1957
  * @hidden
1454
- * Hide from docs
1455
- * ------
1456
1958
  * Checks if teams.fullTrust.joinedTeams capability is supported by the host
1457
1959
  *
1458
1960
  * @returns true if the teams.fullTrust.joinedTeams capability is enabled in
1459
1961
  * runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
1962
+ *
1963
+ * @internal
1964
+ * Limited to Microsoft-internal use
1460
1965
  */
1461
1966
  function isSupported(): boolean;
1462
1967
  }
1463
1968
  /**
1464
1969
  * @hidden
1465
- * Hide from docs
1466
- * ------
1467
1970
  * Allows an app to get the configuration setting value
1468
1971
  *
1469
1972
  * @param key - The key for the config setting
1470
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
1471
1977
  */
1472
1978
  function getConfigSetting(key: string): Promise<string>;
1473
1979
  /**
1474
1980
  * @hidden
1475
- * Hide from docs
1476
- * ------
1477
1981
  * Checks if teams.fullTrust capability is supported by the host
1478
1982
  * @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
1479
1983
  * false if it is disabled
1984
+ *
1985
+ * @internal
1986
+ * Limited to Microsoft-internal use
1480
1987
  */
1481
1988
  function isSupported(): boolean;
1482
1989
  }
@@ -1542,13 +2049,12 @@ export namespace authentication {
1542
2049
  function getAuthToken(authTokenRequest?: AuthTokenRequest): void;
1543
2050
  /**
1544
2051
  * @hidden
1545
- * Hide from docs.
1546
- * ------
1547
2052
  * Requests the decoded Azure AD user identity on behalf of the app.
1548
2053
  *
1549
2054
  * @returns Promise that resolves with the {@link UserProfile}.
1550
2055
  *
1551
2056
  * @internal
2057
+ * Limited to Microsoft-internal use
1552
2058
  */
1553
2059
  function getUser(): Promise<UserProfile>;
1554
2060
  /**
@@ -1556,12 +2062,11 @@ export namespace authentication {
1556
2062
  * As of 2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
1557
2063
  *
1558
2064
  * @hidden
1559
- * Hide from docs.
1560
- * ------
1561
2065
  * Requests the decoded Azure AD user identity on behalf of the app.
1562
2066
  *
1563
2067
  * @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
1564
2068
  * @internal
2069
+ * Limited to Microsoft-internal use
1565
2070
  */
1566
2071
  function getUser(userRequest: UserRequest): void;
1567
2072
  /**
@@ -1656,26 +2161,34 @@ export namespace authentication {
1656
2161
  type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
1657
2162
  /**
1658
2163
  * @hidden
1659
- * Hide from docs.
1660
- * ------
1661
2164
  *
1662
2165
  * @internal
2166
+ * Limited to Microsoft-internal use
1663
2167
  */
1664
2168
  interface UserProfile {
1665
2169
  /**
1666
2170
  * @hidden
1667
2171
  * The intended recipient of the token. The application that receives the token must verify that the audience
1668
2172
  * value is correct and reject any tokens intended for a different audience.
2173
+ *
2174
+ * @internal
2175
+ * Limited to Microsoft-internal use
1669
2176
  */
1670
2177
  aud: string;
1671
2178
  /**
1672
2179
  * @hidden
1673
2180
  * Identifies how the subject of the token was authenticated.
2181
+ *
2182
+ * @internal
2183
+ * Limited to Microsoft-internal use
1674
2184
  */
1675
2185
  amr: string[];
1676
2186
  /**
1677
2187
  * @hidden
1678
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
1679
2192
  */
1680
2193
  iat: number;
1681
2194
  /**
@@ -1683,28 +2196,43 @@ export namespace authentication {
1683
2196
  * Identifies the security token service (STS) that constructs and returns the token. In the tokens that Azure AD
1684
2197
  * returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Azure AD
1685
2198
  * directory. The tenant ID is an immutable and reliable identifier of the directory.
2199
+ *
2200
+ * @internal
2201
+ * Limited to Microsoft-internal use
1686
2202
  */
1687
2203
  iss: string;
1688
2204
  /**
1689
2205
  * @hidden
1690
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
1691
2210
  */
1692
2211
  family_name: string;
1693
2212
  /**
1694
2213
  * @hidden
1695
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
1696
2218
  */
1697
2219
  given_name: string;
1698
2220
  /**
1699
2221
  * @hidden
1700
2222
  * Provides a human-readable value that identifies the subject of the token. This value is not guaranteed to
1701
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
1702
2227
  */
1703
2228
  unique_name: string;
1704
2229
  /**
1705
2230
  * @hidden
1706
2231
  * Contains a unique identifier of an object in Azure AD. This value is immutable and cannot be reassigned or
1707
2232
  * reused. Use the object ID to identify an object in queries to Azure AD.
2233
+ *
2234
+ * @internal
2235
+ * Limited to Microsoft-internal use
1708
2236
  */
1709
2237
  oid: string;
1710
2238
  /**
@@ -1713,6 +2241,9 @@ export namespace authentication {
1713
2241
  * This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
1714
2242
  * checks safely. Because the subject is always present in the tokens the Azure AD issues, we recommended
1715
2243
  * using this value in a general-purpose authorization system.
2244
+ *
2245
+ * @internal
2246
+ * Limited to Microsoft-internal use
1716
2247
  */
1717
2248
  sub: string;
1718
2249
  /**
@@ -1720,6 +2251,9 @@ export namespace authentication {
1720
2251
  * An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can
1721
2252
  * use this value to access tenant-specific directory resources in a multitenant application. For example,
1722
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
1723
2257
  */
1724
2258
  tid: string;
1725
2259
  /**
@@ -1728,6 +2262,9 @@ export namespace authentication {
1728
2262
  * should verify that the current date is within the token lifetime; otherwise it should reject the token. The
1729
2263
  * service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
1730
2264
  * time ("time skew") between Azure AD and the service.
2265
+ *
2266
+ * @internal
2267
+ * Limited to Microsoft-internal use
1731
2268
  */
1732
2269
  exp: number;
1733
2270
  /**
@@ -1736,16 +2273,25 @@ export namespace authentication {
1736
2273
  * should verify that the current date is within the token lifetime; otherwise it should reject the token. The
1737
2274
  * service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
1738
2275
  * time ("time skew") between Azure AD and the service.
2276
+ *
2277
+ * @internal
2278
+ * Limited to Microsoft-internal use
1739
2279
  */
1740
2280
  nbf: number;
1741
2281
  /**
1742
2282
  * @hidden
1743
2283
  * Stores the user name of the user principal.
2284
+ *
2285
+ * @internal
2286
+ * Limited to Microsoft-internal use
1744
2287
  */
1745
2288
  upn: string;
1746
2289
  /**
1747
2290
  * @hidden
1748
2291
  * Stores the version number of the token.
2292
+ *
2293
+ * @internal
2294
+ * Limited to Microsoft-internal use
1749
2295
  */
1750
2296
  ver: string;
1751
2297
  }
@@ -1753,11 +2299,10 @@ export namespace authentication {
1753
2299
  * @deprecated
1754
2300
  * As of 2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
1755
2301
  * @hidden
1756
- * Hide from docs.
1757
- * ------
1758
2302
  * Describes the UserRequest. Success callback describes how a successful request is handled.
1759
2303
  * Failure callback describes how a failed request is handled.
1760
2304
  * @internal
2305
+ * Limited to Microsoft-internal use
1761
2306
  */
1762
2307
  interface UserRequest {
1763
2308
  /**
@@ -1862,6 +2407,7 @@ export interface TabInstance {
1862
2407
  tabName: string;
1863
2408
  /**
1864
2409
  * @internal
2410
+ * Limited to Microsoft-internal use
1865
2411
  * @protected
1866
2412
  */
1867
2413
  internalTabInstanceId?: string;
@@ -2595,9 +3141,9 @@ export interface DialogSize {
2595
3141
  }
2596
3142
  /**
2597
3143
  * @hidden
2598
- * Hide from docs.
2599
3144
  *
2600
3145
  * @internal
3146
+ * Limited to Microsoft-internal use
2601
3147
  */
2602
3148
  export interface LoadContext {
2603
3149
  /**
@@ -3075,27 +3621,28 @@ export namespace app {
3075
3621
  */
3076
3622
  actionInfo?: ActionInfo;
3077
3623
  /**
3078
- * Info of the app
3624
+ * Properties about the current session for your app
3079
3625
  */
3080
3626
  app: AppInfo;
3081
3627
  /**
3082
- * Info of the current page of App
3628
+ * Info about the current page context hosting your app
3083
3629
  */
3084
3630
  page: PageInfo;
3085
3631
  /**
3086
- * Info of the user
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`.
3087
3634
  */
3088
3635
  user?: UserInfo;
3089
3636
  /**
3090
- * Info of the Microsoft Teams channel
3637
+ * When running in the context of a Teams channel, provides information about the channel, else `undefined`
3091
3638
  */
3092
3639
  channel?: ChannelInfo;
3093
3640
  /**
3094
- * Info of the Microsoft Teams chat
3641
+ * When running in the context of a Teams chat, provides information about the chat, else `undefined`
3095
3642
  */
3096
3643
  chat?: ChatInfo;
3097
3644
  /**
3098
- * Info of the Microsoft Teams meeting
3645
+ * When running in the context of a Teams meeting, provides information about the meeting, else `undefined`
3099
3646
  */
3100
3647
  meeting?: MeetingInfo;
3101
3648
  /**
@@ -3103,11 +3650,13 @@ export namespace app {
3103
3650
  */
3104
3651
  sharepoint?: any;
3105
3652
  /**
3106
- * Info of the sharePoint site associated with the team.
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.
3107
3655
  */
3108
3656
  sharePointSite?: SharePointSiteInfo;
3109
3657
  /**
3110
- * Info of the Microsoft Teams team
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.
3111
3660
  */
3112
3661
  team?: TeamInfo;
3113
3662
  }
@@ -3135,20 +3684,18 @@ export namespace app {
3135
3684
  function initialize(validMessageOrigins?: string[]): Promise<void>;
3136
3685
  /**
3137
3686
  * @hidden
3138
- * Hide from docs.
3139
- * ------
3140
3687
  * Undocumented function used to set a mock window for unit tests
3141
3688
  *
3142
3689
  * @internal
3690
+ * Limited to Microsoft-internal use
3143
3691
  */
3144
3692
  function _initialize(hostWindow: any): void;
3145
3693
  /**
3146
3694
  * @hidden
3147
- * Hide from docs.
3148
- * ------
3149
3695
  * Undocumented function used to clear state between unit tests
3150
3696
  *
3151
3697
  * @internal
3698
+ * Limited to Microsoft-internal use
3152
3699
  */
3153
3700
  function _uninitialize(): void;
3154
3701
  /**
@@ -3354,10 +3901,11 @@ export namespace dialog {
3354
3901
  /**
3355
3902
  * @hidden
3356
3903
  * Hide from docs because this function is only used during initialization
3357
- * ------------------
3904
+ *
3358
3905
  * Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
3359
3906
  * Function is called during app initialization
3360
3907
  * @internal
3908
+ * Limited to Microsoft-internal use
3361
3909
  */
3362
3910
  function initialize(): void;
3363
3911
  /**
@@ -3450,20 +3998,20 @@ export namespace dialog {
3450
3998
  }
3451
3999
  /**
3452
4000
  * @hidden
3453
- * Hide from docs
3454
- * --------
4001
+ *
3455
4002
  * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
3456
4003
  *
3457
4004
  * @internal
4005
+ * Limited to Microsoft-internal use
3458
4006
  */
3459
4007
  function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
3460
4008
  /**
3461
4009
  * @hidden
3462
- * Hide from docs
3463
- * --------
4010
+ *
3464
4011
  * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
3465
4012
  *
3466
4013
  * @internal
4014
+ * Limited to Microsoft-internal use
3467
4015
  */
3468
4016
  function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
3469
4017
  }
@@ -3585,6 +4133,7 @@ export namespace pages {
3585
4133
  * @param handler - The handler for placing focus within the application.
3586
4134
  *
3587
4135
  * @internal
4136
+ * Limited to Microsoft-internal use
3588
4137
  */
3589
4138
  function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
3590
4139
  /**
@@ -3738,9 +4287,10 @@ export namespace pages {
3738
4287
  /**
3739
4288
  * @hidden
3740
4289
  * Hide from docs because this function is only used during initialization
3741
- * ------------------
4290
+ *
3742
4291
  * Adds register handlers for settings.save and settings.remove upon initialization. Function is called in {@link app.initializeHelper}
3743
4292
  * @internal
4293
+ * Limited to Microsoft-internal use
3744
4294
  */
3745
4295
  function initialize(): void;
3746
4296
  /**
@@ -3972,21 +4522,33 @@ export namespace menus {
3972
4522
  /**
3973
4523
  * @hidden
3974
4524
  * Represents information about item in View Configuration.
4525
+ *
4526
+ * @internal
4527
+ * Limited to Microsoft-internal use
3975
4528
  */
3976
4529
  interface ViewConfiguration {
3977
4530
  /**
3978
4531
  * @hidden
3979
4532
  * Unique identifier of view.
4533
+ *
4534
+ * @internal
4535
+ * Limited to Microsoft-internal use
3980
4536
  */
3981
4537
  id: string;
3982
4538
  /**
3983
4539
  * @hidden
3984
4540
  * Display title of the view.
4541
+ *
4542
+ * @internal
4543
+ * Limited to Microsoft-internal use
3985
4544
  */
3986
4545
  title: string;
3987
4546
  /**
3988
4547
  * @hidden
3989
4548
  * Additional information for accessibility.
4549
+ *
4550
+ * @internal
4551
+ * Limited to Microsoft-internal use
3990
4552
  */
3991
4553
  contentDescription?: string;
3992
4554
  }
@@ -4569,10 +5131,10 @@ export namespace location {
4569
5131
  export namespace meeting {
4570
5132
  /**
4571
5133
  * @hidden
4572
- * Hide from docs
4573
- * Data structure to represent a meeting details
5134
+ * Data structure to represent meeting details
4574
5135
  *
4575
5136
  * @internal
5137
+ * Limited to Microsoft-internal use
4576
5138
  */
4577
5139
  interface IMeetingDetailsResponse {
4578
5140
  /**
@@ -4638,10 +5200,10 @@ export namespace meeting {
4638
5200
  }
4639
5201
  /**
4640
5202
  * @hidden
4641
- * Hide from docs
4642
5203
  * Data structure to represent a conversation object.
4643
5204
  *
4644
5205
  * @internal
5206
+ * Limited to Microsoft-internal use
4645
5207
  */
4646
5208
  interface IConversation {
4647
5209
  /**
@@ -4652,10 +5214,10 @@ export namespace meeting {
4652
5214
  }
4653
5215
  /**
4654
5216
  * @hidden
4655
- * Hide from docs
4656
5217
  * Data structure to represent an organizer object.
4657
5218
  *
4658
5219
  * @internal
5220
+ * Limited to Microsoft-internal use
4659
5221
  */
4660
5222
  interface IOrganizer {
4661
5223
  /**
@@ -4795,8 +5357,6 @@ export namespace meeting {
4795
5357
  function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
4796
5358
  /**
4797
5359
  * @hidden
4798
- * Hide from docs
4799
- *
4800
5360
  * Allows an app to get the meeting details for the meeting
4801
5361
  *
4802
5362
  * @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
@@ -4804,6 +5364,7 @@ export namespace meeting {
4804
5364
  * result can either contain a IMeetingDetailsResponse value, in case of a successful get or null when the get fails
4805
5365
  *
4806
5366
  * @internal
5367
+ * Limited to Microsoft-internal use
4807
5368
  */
4808
5369
  function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
4809
5370
  /**
@@ -4815,6 +5376,7 @@ export namespace meeting {
4815
5376
  * authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
4816
5377
  *
4817
5378
  * @internal
5379
+ * Limited to Microsoft-internal use
4818
5380
  */
4819
5381
  function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
4820
5382
  /**
@@ -4924,10 +5486,10 @@ export namespace meeting {
4924
5486
  export namespace monetization {
4925
5487
  /**
4926
5488
  * @hidden
4927
- * Hide from docs
4928
5489
  * Data structure to represent a subscription plan.
4929
5490
  *
4930
5491
  * @internal
5492
+ * Limited to Microsoft-internal use
4931
5493
  */
4932
5494
  interface PlanInfo {
4933
5495
  /**
@@ -4943,7 +5505,6 @@ export namespace monetization {
4943
5505
  }
4944
5506
  /**
4945
5507
  * @hidden
4946
- * Hide from docs
4947
5508
  * Open dialog to start user's purchase experience
4948
5509
  *
4949
5510
  * @param planInfo optional parameter. It contains info of the subscription plan pushed to users.
@@ -4951,6 +5512,7 @@ export namespace monetization {
4951
5512
  * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
4952
5513
  *
4953
5514
  * @internal
5515
+ * Limited to Microsoft-internal use
4954
5516
  */
4955
5517
  function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
4956
5518
  /**
@@ -4958,7 +5520,6 @@ export namespace monetization {
4958
5520
  * As of 2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
4959
5521
  *
4960
5522
  * @hidden
4961
- * Hide from docs
4962
5523
  * Open dialog to start user's purchase experience
4963
5524
  *
4964
5525
  * @param callback Callback contains 1 parameters, error.
@@ -4966,6 +5527,7 @@ export namespace monetization {
4966
5527
  * error can either contain an error of type SdkError, incase of an error, or null when get is successful
4967
5528
  *
4968
5529
  * @internal
5530
+ * Limited to Microsoft-internal use
4969
5531
  */
4970
5532
  function openPurchaseExperience(callback: (error: SdkError | null) => void, planInfo?: PlanInfo): void;
4971
5533
  function isSupported(): boolean;
@@ -5251,6 +5813,10 @@ export namespace video {
5251
5813
  * RGB stride, valid only when video frame format is RGB
5252
5814
  */
5253
5815
  stride?: number;
5816
+ /**
5817
+ * The time stamp of the current video frame
5818
+ */
5819
+ timestamp?: number;
5254
5820
  }
5255
5821
  /**
5256
5822
  * Video frame format enum, currently only support NV12
@@ -5324,6 +5890,92 @@ export namespace video {
5324
5890
  function isSupported(): boolean;
5325
5891
  }
5326
5892
 
5893
+ /**
5894
+ * Allows your application to interact with the host M365 application's search box.
5895
+ * By integrating your application with the host's search box, users can search
5896
+ * your app using the same search box they use elsewhere in Teams, Outlook, or Office.
5897
+ *
5898
+ * This functionality is in Beta.
5899
+ * @beta
5900
+ */
5901
+ export namespace search {
5902
+ /**
5903
+ * This interface contains information pertaining to the contents of the host M365 application's search box
5904
+ *
5905
+ * @beta
5906
+ */
5907
+ interface SearchQuery {
5908
+ /** The current search term in the host search experience */
5909
+ searchTerm: string;
5910
+ /** Timestamp sequence value to ensure messages are processed in correct order / combine them. */
5911
+ timestamp: number;
5912
+ }
5913
+ /**
5914
+ * This type will store the SearchQuery and allow other logic to be made inside the handler.
5915
+ *
5916
+ * @beta
5917
+ */
5918
+ type SearchQueryHandler = (query: SearchQuery) => void;
5919
+ /**
5920
+ * Allows the caller to register for various events fired by the host search experience.
5921
+ * Calling this function indicates that your application intends to plug into the host's search box and handle search events,
5922
+ * when the user is actively using your page/tab.
5923
+ *
5924
+ * The host may visually update its search box, e.g. with the name or icon of your application.
5925
+ *
5926
+ * Your application should *not* re-render inside of these callbacks, there may be a large number
5927
+ * of onChangeHandler calls if the user is typing rapidly in the search box.
5928
+ *
5929
+ * @param onChangeHandler - This optional handler will be called when the user first starts using the
5930
+ * host's search box and as the user types their query. Can be used to put your application into a
5931
+ * word-wheeling state or to display suggestions as the user is typing.
5932
+ *
5933
+ * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
5934
+ * with the current contents of the search box.
5935
+ *
5936
+ * @param onClosedHandler - This handler will be called when the user exits or cancels their search.
5937
+ * Should be used to return your application to its most recent, non-search state. The value of {@link SearchQuery.searchTerm}
5938
+ * will be whatever the last query was before ending search.
5939
+ *
5940
+ * @param onExecuteHandler - The handler will be called when the user executes their
5941
+ * search (by pressing Enter for example). Should be used to display the full list of search results.
5942
+ * The value of {@link SearchQuery.searchTerm} is the complete query the user entered in the search box.
5943
+ *
5944
+ * @example
5945
+ * ``` ts
5946
+ * search.registerHandlers(
5947
+ query => {
5948
+ console.log(`Update your application with the changed search query: ${query.searchTerm}`);
5949
+ },
5950
+ query => {
5951
+ console.log('Update your application to handle the search experience being closed. Last query: ${query.searchTerm}');
5952
+ },
5953
+ query => {
5954
+ console.log(`Update your application to handle an executed search result: ${query.searchTerm}`);
5955
+ },
5956
+ );
5957
+ * ```
5958
+ *
5959
+ * @beta
5960
+ */
5961
+ function registerHandlers(onClosedHandler: SearchQueryHandler, onExecuteHandler: SearchQueryHandler, onChangeHandler?: SearchQueryHandler): void;
5962
+ /**
5963
+ * Allows the caller to unregister for all events fired by the host search experience. Calling
5964
+ * this function will cause your app to stop appearing in the set of search scopes in the hosts
5965
+ *
5966
+ * @beta
5967
+ */
5968
+ function unregisterHandlers(): void;
5969
+ /**
5970
+ * Checks if search capability is supported by the host
5971
+ * @returns true if the search capability is supported by the host and false otherwise
5972
+ * false if it is disabled
5973
+ *
5974
+ * @beta
5975
+ */
5976
+ function isSupported(): boolean;
5977
+ }
5978
+
5327
5979
  export namespace sharing {
5328
5980
  export const SharingAPIMessages: {
5329
5981
  shareWebContent: string;
@@ -5568,11 +6220,10 @@ export function initialize(callback?: () => void, validMessageOrigins?: string[]
5568
6220
  * As of 2.0.0, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
5569
6221
  *
5570
6222
  * @hidden
5571
- * Hide from docs.
5572
- * ------
5573
6223
  * Undocumented function used to set a mock window for unit tests
5574
6224
  *
5575
6225
  * @internal
6226
+ * Limited to Microsoft-internal use
5576
6227
  */
5577
6228
  export function _initialize(hostWindow: any): void;
5578
6229
  /**
@@ -5580,11 +6231,10 @@ export function _initialize(hostWindow: any): void;
5580
6231
  * As of 2.0.0, please use {@link app._uninitialize app._uninitialize(): void} instead.
5581
6232
  *
5582
6233
  * @hidden
5583
- * Hide from docs.
5584
- * ------
5585
6234
  * Undocumented function used to clear state between unit tests
5586
6235
  *
5587
6236
  * @internal
6237
+ * Limited to Microsoft-internal use
5588
6238
  */
5589
6239
  export function _uninitialize(): void;
5590
6240
  /**