@microsoft/teams-js 2.0.0-beta.6-dev.5 → 2.0.0-beta.6-dev.8
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/dist/MicrosoftTeams.d.ts +120 -262
- package/dist/MicrosoftTeams.js +552 -461
- 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
@@ -261,6 +261,15 @@ export function registerCustomHandler(actionName: string, customHandler: (...arg
|
|
261
261
|
* @internal
|
262
262
|
*/
|
263
263
|
export function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
|
264
|
+
/**
|
265
|
+
* @hidden
|
266
|
+
* Hide from docs.
|
267
|
+
* ------
|
268
|
+
* Opens a client-friendly preview of the specified file.
|
269
|
+
*
|
270
|
+
* @param file - The file to preview.
|
271
|
+
*/
|
272
|
+
export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
|
264
273
|
|
265
274
|
/**
|
266
275
|
* @hidden
|
@@ -379,8 +388,6 @@ export namespace conversations {
|
|
379
388
|
* Hide from docs
|
380
389
|
* ------
|
381
390
|
* Namespace to interact with the files specific part of the SDK.
|
382
|
-
*
|
383
|
-
* @alpha
|
384
391
|
*/
|
385
392
|
export namespace files {
|
386
393
|
/**
|
@@ -439,6 +446,7 @@ export namespace files {
|
|
439
446
|
* @hidden
|
440
447
|
* Hide from docs
|
441
448
|
* ------
|
449
|
+
*
|
442
450
|
* Cloud storage folder interface
|
443
451
|
*/
|
444
452
|
export interface CloudStorageFolder {
|
@@ -497,6 +505,7 @@ export namespace files {
|
|
497
505
|
* @hidden
|
498
506
|
* Hide from docs
|
499
507
|
* ------
|
508
|
+
*
|
500
509
|
* Cloud storage item interface
|
501
510
|
*/
|
502
511
|
export interface CloudStorageFolderItem {
|
@@ -658,44 +667,51 @@ export namespace files {
|
|
658
667
|
/**
|
659
668
|
* @hidden
|
660
669
|
* Hide from docs
|
661
|
-
* ------
|
662
|
-
* Gets a list of cloud storage folders added to the channel
|
663
670
|
*
|
671
|
+
* Gets a list of cloud storage folders added to the channel
|
664
672
|
* @param channelId - ID of the channel whose cloud storage folders should be retrieved
|
673
|
+
* @param callback - Callback that will be triggered post folders load
|
665
674
|
*/
|
666
|
-
export function getCloudStorageFolders(channelId: string
|
675
|
+
export function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
|
667
676
|
/**
|
668
677
|
* @hidden
|
669
678
|
* Hide from docs
|
670
679
|
* ------
|
671
680
|
* Initiates the add cloud storage folder flow
|
681
|
+
*
|
672
682
|
* @param channelId - ID of the channel to add cloud storage folder
|
683
|
+
* @param callback - Callback that will be triggered post add folder flow is compelete
|
673
684
|
*/
|
674
|
-
export function addCloudStorageFolder(channelId: string
|
685
|
+
export function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
|
675
686
|
/**
|
676
687
|
* @hidden
|
677
688
|
* Hide from docs
|
678
689
|
* ------
|
690
|
+
*
|
679
691
|
* Deletes a cloud storage folder from channel
|
680
692
|
*
|
681
693
|
* @param channelId - ID of the channel where folder is to be deleted
|
682
694
|
* @param folderToDelete - cloud storage folder to be deleted
|
695
|
+
* @param callback - Callback that will be triggered post delete
|
683
696
|
*/
|
684
|
-
export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder):
|
697
|
+
export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
|
685
698
|
/**
|
686
699
|
* @hidden
|
687
700
|
* Hide from docs
|
688
701
|
* ------
|
702
|
+
*
|
689
703
|
* Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
|
690
704
|
*
|
691
705
|
* @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
|
692
706
|
* @param providerCode - Code of the cloud storage folder provider
|
707
|
+
* @param callback - Callback that will be triggered post contents are loaded
|
693
708
|
*/
|
694
|
-
export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider
|
709
|
+
export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
|
695
710
|
/**
|
696
711
|
* @hidden
|
697
712
|
* Hide from docs
|
698
713
|
* ------
|
714
|
+
*
|
699
715
|
* Open a cloud storage file in teams
|
700
716
|
*
|
701
717
|
* @param file - cloud storage file that should be opened
|
@@ -703,15 +719,6 @@ export namespace files {
|
|
703
719
|
* @param fileOpenPreference - Whether file should be opened in web/inline
|
704
720
|
*/
|
705
721
|
export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
|
706
|
-
/**
|
707
|
-
* @hidden
|
708
|
-
* Hide from docs.
|
709
|
-
* ------
|
710
|
-
* Opens a client-friendly preview of the specified file.
|
711
|
-
*
|
712
|
-
* @param file - The file to preview.
|
713
|
-
*/
|
714
|
-
export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
|
715
722
|
/**
|
716
723
|
* @hidden
|
717
724
|
* Allow 1st party apps to call this function to get the external
|
@@ -719,29 +726,18 @@ export namespace files {
|
|
719
726
|
* @param excludeAddedProviders: return a list of support third party
|
720
727
|
* cloud storages that hasn't been added yet.
|
721
728
|
*/
|
722
|
-
export function getExternalProviders(excludeAddedProviders
|
729
|
+
export function getExternalProviders(excludeAddedProviders: boolean, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
|
723
730
|
/**
|
724
731
|
* @hidden
|
725
732
|
* Allow 1st party apps to call this function to move files
|
726
733
|
* among SharePoint and third party cloud storages.
|
727
734
|
*/
|
728
|
-
export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove?:
|
729
|
-
export function isSupported(): boolean;
|
735
|
+
export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean, callback: (error?: SdkError) => void): void;
|
730
736
|
/**
|
731
737
|
* @hidden
|
732
738
|
* Hide from docs
|
733
|
-
*
|
734
|
-
* Gets list of downloads for current user
|
735
|
-
* @param callback Callback that will be triggered post downloads load
|
736
|
-
*/
|
737
|
-
export function getFileDownloads(): Promise<IFileItem[]>;
|
738
|
-
/**
|
739
|
-
* @hidden
|
740
|
-
* Hide from docs
|
741
|
-
* ------
|
739
|
+
* ------
|
742
740
|
*
|
743
|
-
* @deprecated
|
744
|
-
* As of 2.0.0-beta.4, please use {@link file.getFileDownloads file.getFileDownloads(): Promise\<IFileItem[]\>} instead.
|
745
741
|
* Gets list of downloads for current user
|
746
742
|
* @param callback Callback that will be triggered post downloads load
|
747
743
|
*/
|
@@ -751,7 +747,7 @@ export namespace files {
|
|
751
747
|
* Hide from docs
|
752
748
|
*
|
753
749
|
* Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
|
754
|
-
* @param fileObjectId Id of the file whose containing folder should be opened
|
750
|
+
* @param fileObjectId - Id of the file whose containing folder should be opened
|
755
751
|
* @param callback Callback that will be triggered post open download folder/path
|
756
752
|
*/
|
757
753
|
export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;
|
@@ -3452,7 +3448,8 @@ export namespace menus {
|
|
3452
3448
|
}
|
3453
3449
|
|
3454
3450
|
/**
|
3455
|
-
* @
|
3451
|
+
* @deprecated
|
3452
|
+
* As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
|
3456
3453
|
*/
|
3457
3454
|
export namespace media {
|
3458
3455
|
/**
|
@@ -3490,29 +3487,19 @@ export namespace media {
|
|
3490
3487
|
name?: string;
|
3491
3488
|
}
|
3492
3489
|
/**
|
3493
|
-
* Launch camera, capture image or choose image from gallery and return the images as a File[] object
|
3494
|
-
*
|
3495
|
-
* @remarks
|
3496
|
-
* Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
|
3497
|
-
* Note: For desktop, this API is not supported. Promise will be rejected with ErrorCode.NotSupported.
|
3498
|
-
*
|
3499
|
-
* @returns A promise resolved with a collection of @see File objects or rejected with an @see SdkError
|
3500
|
-
*/
|
3501
|
-
export function captureImage(): Promise<File[]>;
|
3502
|
-
/**
|
3503
|
-
* Launch camera, capture image or choose image from gallery and return the images as a File[] object
|
3504
|
-
*
|
3505
|
-
* @param callback - Callback to invoke when the image is captured.
|
3506
|
-
*
|
3507
3490
|
* @deprecated
|
3508
|
-
* As of 2.0.0-beta.
|
3491
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3492
|
+
*
|
3493
|
+
* Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
|
3509
3494
|
*
|
3495
|
+
* @params callback - Callback will be called with an @see SdkError if there are any.
|
3496
|
+
* If error is null or undefined, the callback will be called with a collection of @see File objects
|
3510
3497
|
* @remarks
|
3511
3498
|
* Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
|
3512
3499
|
* Note: For desktop, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
3513
3500
|
*
|
3514
3501
|
*/
|
3515
|
-
export function captureImage(callback: (error
|
3502
|
+
export function captureImage(callback: (error: SdkError, files: File[]) => void): void;
|
3516
3503
|
/**
|
3517
3504
|
* Media object returned by the select Media API
|
3518
3505
|
*/
|
@@ -3525,17 +3512,8 @@ export namespace media {
|
|
3525
3512
|
preview: string;
|
3526
3513
|
/**
|
3527
3514
|
* Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
|
3528
|
-
*
|
3529
|
-
*
|
3530
|
-
*/
|
3531
|
-
getMedia(): Promise<Blob>;
|
3532
|
-
/**
|
3533
|
-
* Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
|
3534
|
-
*
|
3535
|
-
* @deprecated
|
3536
|
-
* As of 2.0.0-beta.1, please use {@link media.Media.getMedia media.Media.getMedia(): Promise\<Blob\>} instead.
|
3537
|
-
*
|
3538
|
-
* @param callback - returns blob of media
|
3515
|
+
* @param callback - callback is called with the @see SdkError if there is an error
|
3516
|
+
* If error is null or undefined, the callback will be called with @see Blob.
|
3539
3517
|
*/
|
3540
3518
|
getMedia(callback: (error: SdkError, blob: Blob) => void): void;
|
3541
3519
|
}
|
@@ -3668,7 +3646,7 @@ export namespace media {
|
|
3668
3646
|
*/
|
3669
3647
|
abstract class MediaController<T> {
|
3670
3648
|
protected controllerCallback: T;
|
3671
|
-
constructor(controllerCallback
|
3649
|
+
constructor(controllerCallback?: T);
|
3672
3650
|
protected abstract getMediaType(): MediaType;
|
3673
3651
|
/**
|
3674
3652
|
* @hidden
|
@@ -3683,20 +3661,6 @@ export namespace media {
|
|
3683
3661
|
* @hidden
|
3684
3662
|
* Hide from docs
|
3685
3663
|
* --------
|
3686
|
-
*
|
3687
|
-
* Function to notify the host client to programatically control the experience
|
3688
|
-
* @param mediaEvent indicates what the event that needs to be signaled to the host client
|
3689
|
-
* @returns A promise resolved promise
|
3690
|
-
*/
|
3691
|
-
protected notifyEventToHost(mediaEvent: MediaControllerEvent): Promise<void>;
|
3692
|
-
/**
|
3693
|
-
* @hidden
|
3694
|
-
* Hide from docs
|
3695
|
-
* --------
|
3696
|
-
*
|
3697
|
-
* @deprecated
|
3698
|
-
* As of 2.0.0-beta.3, please use {@link media.MediaController.notifyEventToHost media.MediaController.notifyEventToHost(mediaEvent: MediaControllerEvent): Promise\<void\>} instead.
|
3699
|
-
*
|
3700
3664
|
* Function to notify the host client to programatically control the experience
|
3701
3665
|
* @param mediaEvent indicates what the event that needs to be signaled to the host client
|
3702
3666
|
* Optional; @param callback is used to send app if host client has successfully handled the notification event or not
|
@@ -3704,17 +3668,6 @@ export namespace media {
|
|
3704
3668
|
protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: (err?: SdkError) => void): void;
|
3705
3669
|
/**
|
3706
3670
|
* Function to programatically stop the ongoing media event
|
3707
|
-
*
|
3708
|
-
* @returns A resolved promise
|
3709
|
-
* */
|
3710
|
-
stop(): Promise<void>;
|
3711
|
-
/**
|
3712
|
-
*
|
3713
|
-
* Function to programatically stop the ongoing media event
|
3714
|
-
*
|
3715
|
-
* @deprecated
|
3716
|
-
* As of 2.0.0-beta.3, please use {@link media.MediaController.stop media.MediaController.stop(): Promise\<void\>} instead.
|
3717
|
-
*
|
3718
3671
|
* Optional; @param callback is used to send app if host client has successfully stopped the event or not
|
3719
3672
|
*/
|
3720
3673
|
stop(callback?: (err?: SdkError) => void): void;
|
@@ -3723,8 +3676,7 @@ export namespace media {
|
|
3723
3676
|
* Callback which will register your app to listen to lifecycle events during the video capture flow
|
3724
3677
|
*/
|
3725
3678
|
export interface VideoControllerCallback {
|
3726
|
-
onRecordingStarted(): void;
|
3727
|
-
onRecordingStopped?(): void;
|
3679
|
+
onRecordingStarted?(): void;
|
3728
3680
|
}
|
3729
3681
|
/**
|
3730
3682
|
* VideoController class is used to communicate between the app and the host client during the video capture flow
|
@@ -3823,39 +3775,24 @@ export namespace media {
|
|
3823
3775
|
file: Blob;
|
3824
3776
|
}
|
3825
3777
|
/**
|
3826
|
-
*
|
3778
|
+
* @deprecated
|
3779
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3827
3780
|
*
|
3828
|
-
* @param mediaInputs - The input params to customize the media to be selected
|
3829
|
-
* @returns A promise resolved with an array of media data or rejected with an @see SdkError
|
3830
|
-
*/
|
3831
|
-
export function selectMedia(mediaInputs: MediaInputs): Promise<Media[]>;
|
3832
|
-
/**
|
3833
3781
|
* Select an attachment using camera/gallery
|
3834
3782
|
*
|
3835
|
-
* @deprecated
|
3836
|
-
* As of 2.0.0-beta.1, please use {@link media.selectMedia media.selectMedia(mediaInputs: MediaInputs): Promise\<Media[]\>} instead.
|
3837
|
-
*
|
3838
3783
|
* @param mediaInputs - The input params to customize the media to be selected
|
3839
3784
|
* @param callback - The callback to invoke after fetching the media
|
3840
3785
|
*/
|
3841
|
-
export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void):
|
3786
|
+
export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): void;
|
3842
3787
|
/**
|
3843
|
-
* View images using native image viewer
|
3844
|
-
*
|
3845
|
-
* @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
|
3846
|
-
* @returns A promise resolved when the viewing action is completed or rejected with an @see SdkError
|
3847
|
-
*/
|
3848
|
-
export function viewImages(uriList: ImageUri[]): Promise<void>;
|
3849
|
-
/**
|
3850
|
-
* View images using native image viewer
|
3851
|
-
*
|
3852
3788
|
* @deprecated
|
3853
|
-
* As of 2.0.0-beta.
|
3789
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3854
3790
|
*
|
3791
|
+
* View images using native image viewer
|
3855
3792
|
* @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
|
3856
3793
|
* @param callback - returns back error if encountered, returns null in case of success
|
3857
3794
|
*/
|
3858
|
-
export function viewImages(uriList: ImageUri[], callback: (error?: SdkError) => void):
|
3795
|
+
export function viewImages(uriList: ImageUri[], callback: (error?: SdkError) => void): void;
|
3859
3796
|
/**
|
3860
3797
|
* Barcode configuration supplied to scanBarCode API to customize barcode scanning experience in mobile
|
3861
3798
|
* All properties in BarCodeConfig are optional and have default values in the platform
|
@@ -3868,29 +3805,17 @@ export namespace media {
|
|
3868
3805
|
timeOutIntervalInSec?: number;
|
3869
3806
|
}
|
3870
3807
|
/**
|
3871
|
-
*
|
3872
|
-
*
|
3873
|
-
* @remarks
|
3874
|
-
* Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
3808
|
+
* @deprecated
|
3809
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3875
3810
|
*
|
3876
|
-
* @param config - optional input configuration to customize the barcode scanning experience
|
3877
|
-
* @returns A promise resolved with the barcode data or rejected with an @see SdkError
|
3878
|
-
*/
|
3879
|
-
export function scanBarCode(config?: BarCodeConfig): Promise<string>;
|
3880
|
-
/**
|
3881
3811
|
* Scan Barcode/QRcode using camera
|
3882
|
-
*
|
3883
3812
|
* @remarks
|
3884
3813
|
* Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
3885
3814
|
*
|
3886
|
-
* @deprecated
|
3887
|
-
* As of 2.0.0-beta.1, please use {@link media.scanBarCode media.scanBarCode(config?: BarCodeConfig): Promise\<string\>} instead.
|
3888
|
-
*
|
3889
3815
|
* @param callback - callback to invoke after scanning the barcode
|
3890
3816
|
* @param config - optional input configuration to customize the barcode scanning experience
|
3891
3817
|
*/
|
3892
|
-
export function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig):
|
3893
|
-
export function isSupported(): boolean;
|
3818
|
+
export function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig): void;
|
3894
3819
|
export {};
|
3895
3820
|
}
|
3896
3821
|
|
@@ -3965,7 +3890,8 @@ export namespace location {
|
|
3965
3890
|
}
|
3966
3891
|
|
3967
3892
|
/**
|
3968
|
-
* @
|
3893
|
+
* @deprecated
|
3894
|
+
* As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
|
3969
3895
|
*/
|
3970
3896
|
export namespace meeting {
|
3971
3897
|
/**
|
@@ -3975,12 +3901,12 @@ export namespace meeting {
|
|
3975
3901
|
*
|
3976
3902
|
* @internal
|
3977
3903
|
*/
|
3978
|
-
interface
|
3904
|
+
interface IMeetingDetailsResponse {
|
3979
3905
|
/**
|
3980
3906
|
* @hidden
|
3981
3907
|
* details object
|
3982
3908
|
*/
|
3983
|
-
details:
|
3909
|
+
details: IMeetingDetails | ICallDetails;
|
3984
3910
|
/**
|
3985
3911
|
* @hidden
|
3986
3912
|
* conversation object
|
@@ -3995,36 +3921,47 @@ export namespace meeting {
|
|
3995
3921
|
/**
|
3996
3922
|
* @hidden
|
3997
3923
|
* Hide from docs
|
3998
|
-
*
|
3999
|
-
*
|
4000
|
-
* @internal
|
3924
|
+
* Base data structure to represent a meeting or call detail
|
4001
3925
|
*/
|
4002
|
-
interface
|
3926
|
+
interface IMeetingOrCallDetailsBase<T> {
|
4003
3927
|
/**
|
4004
3928
|
* @hidden
|
4005
|
-
* Scheduled start time of the meeting
|
3929
|
+
* Scheduled start time of the meeting or start time of the call
|
4006
3930
|
*/
|
4007
3931
|
scheduledStartTime: string;
|
4008
3932
|
/**
|
4009
3933
|
* @hidden
|
4010
|
-
*
|
3934
|
+
* url to join the current meeting or call
|
4011
3935
|
*/
|
4012
|
-
|
3936
|
+
joinUrl?: string;
|
4013
3937
|
/**
|
4014
3938
|
* @hidden
|
4015
|
-
*
|
3939
|
+
* type of the meeting or call
|
4016
3940
|
*/
|
4017
|
-
|
3941
|
+
type?: T;
|
3942
|
+
}
|
3943
|
+
/**
|
3944
|
+
* @hidden
|
3945
|
+
* Hide from docs
|
3946
|
+
* Data structure to represent call details
|
3947
|
+
*/
|
3948
|
+
type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
|
3949
|
+
/**
|
3950
|
+
* @hidden
|
3951
|
+
* Hide from docs
|
3952
|
+
* Data structure to represent meeting details.
|
3953
|
+
*/
|
3954
|
+
interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
|
4018
3955
|
/**
|
4019
3956
|
* @hidden
|
4020
|
-
*
|
3957
|
+
* Scheduled end time of the meeting
|
4021
3958
|
*/
|
4022
|
-
|
3959
|
+
scheduledEndTime: string;
|
4023
3960
|
/**
|
4024
3961
|
* @hidden
|
4025
|
-
*
|
3962
|
+
* meeting title name of the meeting
|
4026
3963
|
*/
|
4027
|
-
|
3964
|
+
title?: string;
|
4028
3965
|
}
|
4029
3966
|
/**
|
4030
3967
|
* @hidden
|
@@ -4074,6 +4011,12 @@ export namespace meeting {
|
|
4074
4011
|
message?: string;
|
4075
4012
|
};
|
4076
4013
|
}
|
4014
|
+
interface IAppContentStageSharingCapabilities {
|
4015
|
+
/**
|
4016
|
+
* indicates whether app has permission to share contents to meeting stage
|
4017
|
+
*/
|
4018
|
+
doesAppHaveSharePermission: boolean;
|
4019
|
+
}
|
4077
4020
|
interface IAppContentStageSharingState {
|
4078
4021
|
/**
|
4079
4022
|
* indicates whether app is currently being shared to stage
|
@@ -4087,12 +4030,6 @@ export namespace meeting {
|
|
4087
4030
|
*/
|
4088
4031
|
isSpeakingDetected: boolean;
|
4089
4032
|
}
|
4090
|
-
interface IAppContentStageSharingCapabilities {
|
4091
|
-
/**
|
4092
|
-
* indicates whether app has permission to share contents to meeting stage
|
4093
|
-
*/
|
4094
|
-
doesAppHaveSharePermission: boolean;
|
4095
|
-
}
|
4096
4033
|
enum MeetingType {
|
4097
4034
|
Unknown = "Unknown",
|
4098
4035
|
Adhoc = "Adhoc",
|
@@ -4101,41 +4038,28 @@ export namespace meeting {
|
|
4101
4038
|
Broadcast = "Broadcast",
|
4102
4039
|
MeetNow = "MeetNow"
|
4103
4040
|
}
|
4104
|
-
|
4105
|
-
|
4106
|
-
|
4107
|
-
|
4108
|
-
* error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
|
4109
|
-
* result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
|
4110
|
-
*
|
4111
|
-
* @returns Promise result where true means incoming audio is muted and false means incoming audio is unmuted
|
4112
|
-
*/
|
4113
|
-
function getIncomingClientAudioState(): Promise<boolean>;
|
4041
|
+
enum CallType {
|
4042
|
+
OneOnOneCall = "oneOnOneCall",
|
4043
|
+
GroupCall = "groupCall"
|
4044
|
+
}
|
4114
4045
|
/**
|
4115
4046
|
* @deprecated
|
4116
|
-
* As of 2.0.0-beta.
|
4047
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4117
4048
|
*
|
4118
4049
|
* Allows an app to get the incoming audio speaker setting for the meeting user
|
4119
4050
|
*
|
4120
4051
|
* @param callback - Callback contains 2 parameters, error and result.
|
4052
|
+
*
|
4121
4053
|
* error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
|
4122
4054
|
* result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
|
4123
4055
|
* result: True means incoming audio is muted and false means incoming audio is unmuted
|
4124
4056
|
*/
|
4125
4057
|
function getIncomingClientAudioState(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4126
|
-
/**
|
4127
|
-
* Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
|
4128
|
-
*
|
4129
|
-
* @remarks
|
4130
|
-
* error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
|
4131
|
-
* result can either contain the true/false value, incase of a successful toggle or null when the toggling fails
|
4132
|
-
*
|
4133
|
-
* @returns Promise result where true means incoming audio is muted and false means incoming audio is unmuted or rejected promise containing SdkError details
|
4134
|
-
*/
|
4135
|
-
function toggleIncomingClientAudio(): Promise<boolean>;
|
4136
4058
|
/**
|
4137
4059
|
* @deprecated
|
4138
|
-
* As of 2.0.0-beta.
|
4060
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4061
|
+
*
|
4062
|
+
* Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
|
4139
4063
|
*
|
4140
4064
|
* @param callback - Callback contains 2 parameters, error and result.
|
4141
4065
|
* error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
|
@@ -4143,50 +4067,29 @@ export namespace meeting {
|
|
4143
4067
|
* result: True means incoming audio is muted and false means incoming audio is unmuted
|
4144
4068
|
*/
|
4145
4069
|
function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4146
|
-
/**
|
4147
|
-
* @hidden
|
4148
|
-
* Hide from docs
|
4149
|
-
*
|
4150
|
-
* Allows an app to get the meeting details for the meeting
|
4151
|
-
*
|
4152
|
-
* @returns Promise containing the meeting details in IMeetingDetails form or rejected promise containing SdkError details
|
4153
|
-
*
|
4154
|
-
* @internal
|
4155
|
-
*/
|
4156
|
-
function getMeetingDetails(): Promise<IMeetingDetails>;
|
4157
4070
|
/**
|
4158
4071
|
* @deprecated
|
4159
|
-
* As of 2.0.0-beta.
|
4072
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4160
4073
|
*
|
4161
4074
|
* @hidden
|
4162
4075
|
* Hide from docs
|
4163
4076
|
*
|
4164
4077
|
* Allows an app to get the meeting details for the meeting
|
4165
4078
|
*
|
4166
|
-
* @param callback - Callback contains 2 parameters, error and
|
4079
|
+
* @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
|
4167
4080
|
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
4168
|
-
* result can either contain a
|
4169
|
-
*
|
4170
|
-
* @internal
|
4171
|
-
*/
|
4172
|
-
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetails | null) => void): void;
|
4173
|
-
/**
|
4174
|
-
* @hidden
|
4175
|
-
* Allows an app to get the authentication token for the anonymous or guest user in the meeting
|
4176
|
-
*
|
4177
|
-
* @returns Promise containing the token or rejected promise containing SdkError details
|
4081
|
+
* result can either contain a IMeetingDetailsResponse value, incase of a successful get or null when the get fails
|
4178
4082
|
*
|
4179
4083
|
* @internal
|
4180
4084
|
*/
|
4181
|
-
function
|
4085
|
+
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
4182
4086
|
/**
|
4183
4087
|
* @deprecated
|
4184
|
-
* As of 2.0.0-beta.
|
4088
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4185
4089
|
*
|
4186
4090
|
* @hidden
|
4187
|
-
* Hide from docs
|
4188
|
-
*
|
4189
4091
|
* Allows an app to get the authentication token for the anonymous or guest user in the meeting
|
4092
|
+
*
|
4190
4093
|
* @param callback - Callback contains 2 parameters, error and authenticationTokenOfAnonymousUser.
|
4191
4094
|
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
4192
4095
|
* authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
|
@@ -4194,16 +4097,9 @@ export namespace meeting {
|
|
4194
4097
|
* @internal
|
4195
4098
|
*/
|
4196
4099
|
function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
4197
|
-
function isSupported(): boolean;
|
4198
|
-
/**
|
4199
|
-
* Allows an app to get the state of the live stream in the current meeting
|
4200
|
-
*
|
4201
|
-
* @returns Promise containing the LiveStreamState value or rejected promise containing SdkError details
|
4202
|
-
*/
|
4203
|
-
function getLiveStreamState(): Promise<LiveStreamState>;
|
4204
4100
|
/**
|
4205
4101
|
* @deprecated
|
4206
|
-
* As of 2.0.0-beta.
|
4102
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4207
4103
|
*
|
4208
4104
|
* Allows an app to get the state of the live stream in the current meeting
|
4209
4105
|
*
|
@@ -4213,6 +4109,9 @@ export namespace meeting {
|
|
4213
4109
|
*/
|
4214
4110
|
function getLiveStreamState(callback: (error: SdkError | null, liveStreamState: LiveStreamState | null) => void): void;
|
4215
4111
|
/**
|
4112
|
+
* @deprecated
|
4113
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4114
|
+
*
|
4216
4115
|
* Allows an app to request the live streaming be started at the given streaming url
|
4217
4116
|
*
|
4218
4117
|
* @remarks
|
@@ -4220,42 +4119,25 @@ export namespace meeting {
|
|
4220
4119
|
*
|
4221
4120
|
* @param streamUrl - the url to the stream resource
|
4222
4121
|
* @param streamKey - the key to the stream resource
|
4223
|
-
* @
|
4122
|
+
* @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
|
4224
4123
|
*/
|
4225
|
-
function requestStartLiveStreaming(streamUrl: string, streamKey?: string):
|
4124
|
+
function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): void;
|
4226
4125
|
/**
|
4227
4126
|
* @deprecated
|
4228
|
-
* As of 2.0.0-beta.
|
4127
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4229
4128
|
*
|
4230
|
-
* Allows an app to request the live streaming be started at the given streaming url
|
4231
|
-
*
|
4232
|
-
* @param streamUrl - The url to the stream resource
|
4233
|
-
* @param streamKey - The key to the stream resource
|
4234
|
-
* @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
|
4235
|
-
*
|
4236
|
-
* Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
|
4237
|
-
*/
|
4238
|
-
function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): Promise<void>;
|
4239
|
-
/**
|
4240
4129
|
* Allows an app to request the live streaming be stopped at the given streaming url
|
4241
4130
|
*
|
4242
4131
|
* @remarks
|
4243
4132
|
* Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
|
4244
4133
|
*
|
4245
|
-
* @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
|
4246
|
-
*/
|
4247
|
-
function requestStopLiveStreaming(): Promise<void>;
|
4248
|
-
/**
|
4249
|
-
* @deprecated
|
4250
|
-
* As of 2.0.0-beta.1, please use {@link meeting.requestStopLiveStreaming meeting.requestStopLiveStreaming(): Promise\<void\>} instead.
|
4251
|
-
*
|
4252
|
-
* Allows an app to request the live streaming be stopped at the given streaming url
|
4253
4134
|
* @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
|
4254
|
-
*
|
4255
|
-
* Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
|
4256
4135
|
*/
|
4257
4136
|
function requestStopLiveStreaming(callback: (error: SdkError | null) => void): void;
|
4258
4137
|
/**
|
4138
|
+
* @deprecated
|
4139
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4140
|
+
*
|
4259
4141
|
* Registers a handler for changes to the live stream.
|
4260
4142
|
*
|
4261
4143
|
* @remarks
|
@@ -4264,16 +4146,9 @@ export namespace meeting {
|
|
4264
4146
|
* @param handler - The handler to invoke when the live stream state changes
|
4265
4147
|
*/
|
4266
4148
|
function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
|
4267
|
-
/**
|
4268
|
-
* Allows an app to share contents in the meeting
|
4269
|
-
*
|
4270
|
-
* @param appContentUrl - appContentUrl is the input URL which needs to be shared on to the stage
|
4271
|
-
* @returns Promise resolved indicating whether or not the share was successful or rejected with SdkError value
|
4272
|
-
*/
|
4273
|
-
function shareAppContentToStage(appContentUrl: string): Promise<boolean>;
|
4274
4149
|
/**
|
4275
4150
|
* @deprecated
|
4276
|
-
* As of 2.0.0-beta.
|
4151
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4277
4152
|
*
|
4278
4153
|
* Allows an app to share contents in the meeting
|
4279
4154
|
*
|
@@ -4283,17 +4158,11 @@ export namespace meeting {
|
|
4283
4158
|
* @param appContentUrl - is the input URL which needs to be shared on to the stage
|
4284
4159
|
*/
|
4285
4160
|
function shareAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void, appContentUrl: string): void;
|
4286
|
-
/**
|
4287
|
-
* Provides information related to app's in-meeting sharing capabilities
|
4288
|
-
*
|
4289
|
-
* @returns Promise resolved with sharing capability details or rejected with SdkError value
|
4290
|
-
*/
|
4291
|
-
function getAppContentStageSharingCapabilities(): Promise<IAppContentStageSharingCapabilities>;
|
4292
4161
|
/**
|
4293
4162
|
* @deprecated
|
4294
|
-
* As of 2.0.0-beta.
|
4163
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4295
4164
|
*
|
4296
|
-
* Provides information related
|
4165
|
+
* Provides information related app's in-meeting sharing capabilities
|
4297
4166
|
*
|
4298
4167
|
* @param callback - Callback contains 2 parameters, error and result.
|
4299
4168
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
@@ -4301,40 +4170,25 @@ export namespace meeting {
|
|
4301
4170
|
* (indication of successful retrieval), or null (indication of failed retrieval)
|
4302
4171
|
*/
|
4303
4172
|
function getAppContentStageSharingCapabilities(callback: (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void): void;
|
4304
|
-
/**
|
4305
|
-
* @hidden
|
4306
|
-
* Hide from docs.
|
4307
|
-
* ------------------------------------------
|
4308
|
-
* Terminates current stage sharing session in meeting
|
4309
|
-
*
|
4310
|
-
* @returns Promise resolved indicating whether or not sharing successfully stopped or rejected with SdkError value
|
4311
|
-
*/
|
4312
|
-
function stopSharingAppContentToStage(): Promise<boolean>;
|
4313
4173
|
/**
|
4314
4174
|
* @deprecated
|
4315
|
-
* As of 2.0.0-beta.
|
4175
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4316
4176
|
*
|
4317
4177
|
* @hidden
|
4318
4178
|
* Hide from docs.
|
4319
|
-
* ------------------------------------------
|
4320
4179
|
* Terminates current stage sharing session in meeting
|
4321
|
-
*
|
4180
|
+
*
|
4181
|
+
* @param callback - Callback contains 2 parameters, error and result.
|
4322
4182
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
4323
4183
|
* result can either contain a true boolean value (successful termination), or null (unsuccessful fetch)
|
4324
|
-
* @internal
|
4325
4184
|
*/
|
4326
4185
|
function stopSharingAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4327
|
-
/**
|
4328
|
-
* Provides information related to current stage sharing state for app
|
4329
|
-
*
|
4330
|
-
* @returns Promise resolved to the App Content Stage Sharing State, or rejected with SdkError value
|
4331
|
-
*/
|
4332
|
-
function getAppContentStageSharingState(): Promise<IAppContentStageSharingState>;
|
4333
4186
|
/**
|
4334
4187
|
* @deprecated
|
4335
|
-
* As of 2.0.0-beta.
|
4188
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4336
4189
|
*
|
4337
4190
|
* Provides information related to current stage sharing state for app
|
4191
|
+
*
|
4338
4192
|
* @param callback - Callback contains 2 parameters, error and result.
|
4339
4193
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
4340
4194
|
* appContentStageSharingState can either contain an IAppContentStageSharingState object
|
@@ -4342,9 +4196,13 @@ export namespace meeting {
|
|
4342
4196
|
*/
|
4343
4197
|
function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
|
4344
4198
|
/**
|
4199
|
+
* @deprecated
|
4200
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4201
|
+
*
|
4345
4202
|
* Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
|
4346
4203
|
* will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
|
4347
4204
|
* at a time. A subsequent registration replaces an existing registration.
|
4205
|
+
*
|
4348
4206
|
* @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
|
4349
4207
|
*/
|
4350
4208
|
function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
|