@microsoft/teams-js 2.0.0-beta.6-dev.6 → 2.0.0-beta.6-dev.7

package/dist/MicrosoftTeams.d.ts

@@ -3961,7 +3961,8 @@ export namespace location {
 }
 
 /**
-    * @alpha
+    * @deprecated
+    * As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
     */
 export namespace meeting {
         /**
@@ -3971,12 +3972,12 @@ export namespace meeting {
             *
             * @internal
             */
-        interface IMeetingDetails {
+        interface IMeetingDetailsResponse {
                 /**
                     * @hidden
                     * details object
                     */
-                details: IDetails;
+                details: IMeetingDetails | ICallDetails;
                 /**
                     * @hidden
                     * conversation object
@@ -3991,36 +3992,47 @@ export namespace meeting {
         /**
             * @hidden
             * Hide from docs
-            * Data structure to represent details.
-            *
-            * @internal
+            * Base data structure to represent a meeting or call detail
             */
-        interface IDetails {
+        interface IMeetingOrCallDetailsBase<T> {
                 /**
                     * @hidden
-                    * Scheduled start time of the meeting
+                    * Scheduled start time of the meeting or start time of the call
                     */
                 scheduledStartTime: string;
                 /**
                     * @hidden
-                    * Scheduled end time of the meeting
+                    * url to join the current meeting or call
                     */
-                scheduledEndTime: string;
+                joinUrl?: string;
                 /**
                     * @hidden
-                    * url to join the current meeting
+                    * type of the meeting or call
                     */
-                joinUrl?: string;
+                type?: T;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            * Data structure to represent call details
+            */
+        type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
+        /**
+            * @hidden
+            * Hide from docs
+            * Data structure to represent meeting details.
+            */
+        interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
                 /**
                     * @hidden
-                    * meeting title name of the meeting
+                    * Scheduled end time of the meeting
                     */
-                title?: string;
+                scheduledEndTime: string;
                 /**
                     * @hidden
-                    * type of the meeting
+                    * meeting title name of the meeting
                     */
-                type?: MeetingType;
+                title?: string;
         }
         /**
             * @hidden
@@ -4070,6 +4082,12 @@ export namespace meeting {
                         message?: string;
                 };
         }
+        interface IAppContentStageSharingCapabilities {
+                /**
+                    * indicates whether app has permission to share contents to meeting stage
+                    */
+                doesAppHaveSharePermission: boolean;
+        }
         interface IAppContentStageSharingState {
                 /**
                     * indicates whether app is currently being shared to stage
@@ -4083,12 +4101,6 @@ export namespace meeting {
                     */
                 isSpeakingDetected: boolean;
         }
-        interface IAppContentStageSharingCapabilities {
-                /**
-                    * indicates whether app has permission to share contents to meeting stage
-                    */
-                doesAppHaveSharePermission: boolean;
-        }
         enum MeetingType {
                 Unknown = "Unknown",
                 Adhoc = "Adhoc",
@@ -4097,41 +4109,28 @@ export namespace meeting {
                 Broadcast = "Broadcast",
                 MeetNow = "MeetNow"
         }
-        /**
-            * Allows an app to get the incoming audio speaker setting for the meeting user
-            *
-            * @remarks
-            * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
-            * result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
-            *
-            * @returns Promise result where true means incoming audio is muted and false means incoming audio is unmuted
-            */
-        function getIncomingClientAudioState(): Promise<boolean>;
+        enum CallType {
+                OneOnOneCall = "oneOnOneCall",
+                GroupCall = "groupCall"
+        }
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.getIncomingClientAudioState meeting.getIncomingClientAudioState(): Promise\<boolean\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * Allows an app to get the incoming audio speaker setting for the meeting user
             *
             * @param callback - Callback contains 2 parameters, error and result.
+            *
             * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
             * result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
             * result: True means incoming audio is muted and false means incoming audio is unmuted
             */
         function getIncomingClientAudioState(callback: (error: SdkError | null, result: boolean | null) => void): void;
-        /**
-            * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
-            *
-            * @remarks
-            * error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
-            * result can either contain the true/false value, incase of a successful toggle or null when the toggling fails
-            *
-            * @returns Promise result where true means incoming audio is muted and false means incoming audio is unmuted or rejected promise containing SdkError details
-            */
-        function toggleIncomingClientAudio(): Promise<boolean>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.toggleIncomingClientAudio meeting.toggleIncomingClientAudio(): Promise\<boolean\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+            *
+            * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
             *
             * @param callback - Callback contains 2 parameters, error and result.
             * error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
@@ -4139,50 +4138,29 @@ export namespace meeting {
             * result: True means incoming audio is muted and false means incoming audio is unmuted
             */
         function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
-        /**
-            * @hidden
-            * Hide from docs
-            *
-            * Allows an app to get the meeting details for the meeting
-            *
-            * @returns Promise containing the meeting details in IMeetingDetails form or rejected promise containing SdkError details
-            *
-            * @internal
-            */
-        function getMeetingDetails(): Promise<IMeetingDetails>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.getMeetingDetails meeting.getMeetingDetails(): Promise\<IMeetingDetails\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * @hidden
             * Hide from docs
             *
             * Allows an app to get the meeting details for the meeting
             *
-            * @param callback - Callback contains 2 parameters, error and meetingDetails.
+            * @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
             * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-            * result can either contain a IMeetingDetails value, incase of a successful get or null when the get fails
-            *
-            * @internal
-            */
-        function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetails | null) => void): void;
-        /**
-            * @hidden
-            * Allows an app to get the authentication token for the anonymous or guest user in the meeting
-            *
-            * @returns Promise containing the token or rejected promise containing SdkError details
+            * result can either contain a IMeetingDetailsResponse value, incase of a successful get or null when the get fails
             *
             * @internal
             */
-        function getAuthenticationTokenForAnonymousUser(): Promise<string>;
+        function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.getAuthenticationTokenForAnonymousUser meeting.getAuthenticationTokenForAnonymousUser(): Promise\<string\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * @hidden
-            * Hide from docs
-            *
             * Allows an app to get the authentication token for the anonymous or guest user in the meeting
+            *
             * @param callback - Callback contains 2 parameters, error and authenticationTokenOfAnonymousUser.
             * error can either contain an error of type SdkError, incase of an error, or null when get is successful
             * authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
@@ -4190,16 +4168,9 @@ export namespace meeting {
             * @internal
             */
         function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
-        function isSupported(): boolean;
-        /**
-            * Allows an app to get the state of the live stream in the current meeting
-            *
-            * @returns Promise containing the LiveStreamState value or rejected promise containing SdkError details
-            */
-        function getLiveStreamState(): Promise<LiveStreamState>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.getLiveStreamState meeting.getLiveStreamState(): Promise\<LiveStreamState\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * Allows an app to get the state of the live stream in the current meeting
             *
@@ -4209,6 +4180,9 @@ export namespace meeting {
             */
         function getLiveStreamState(callback: (error: SdkError | null, liveStreamState: LiveStreamState | null) => void): void;
         /**
+            * @deprecated
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+            *
             * Allows an app to request the live streaming be started at the given streaming url
             *
             * @remarks
@@ -4216,42 +4190,25 @@ export namespace meeting {
             *
             * @param streamUrl - the url to the stream resource
             * @param streamKey - the key to the stream resource
-            * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
+            * @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
             */
-        function requestStartLiveStreaming(streamUrl: string, streamKey?: string): Promise<void>;
+        function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): void;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.requestStartLiveStreaming meeting.requestStartLiveStreaming(streamUrl: string, streamKey?: string): Promise\<void\>} instead.
-            *
-            * Allows an app to request the live streaming be started at the given streaming url
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
-            * @param streamUrl - The url to the stream resource
-            * @param streamKey - The key to the stream resource
-            * @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
-            *
-            * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
-            */
-        function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): Promise<void>;
-        /**
             * Allows an app to request the live streaming be stopped at the given streaming url
             *
             * @remarks
             * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
             *
-            * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
-            */
-        function requestStopLiveStreaming(): Promise<void>;
-        /**
-            * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.requestStopLiveStreaming meeting.requestStopLiveStreaming(): Promise\<void\>} instead.
-            *
-            * Allows an app to request the live streaming be stopped at the given streaming url
             * @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
-            *
-            * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
             */
         function requestStopLiveStreaming(callback: (error: SdkError | null) => void): void;
         /**
+            * @deprecated
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+            *
             * Registers a handler for changes to the live stream.
             *
             * @remarks
@@ -4260,16 +4217,9 @@ export namespace meeting {
             * @param handler - The handler to invoke when the live stream state changes
             */
         function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
-        /**
-            * Allows an app to share contents in the meeting
-            *
-            * @param appContentUrl - appContentUrl is the input URL which needs to be shared on to the stage
-            * @returns Promise resolved indicating whether or not the share was successful or rejected with SdkError value
-            */
-        function shareAppContentToStage(appContentUrl: string): Promise<boolean>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.shareAppContentToStage meeting.shareAppContentToStage(appContentUrl: string): Promise\<boolean\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * Allows an app to share contents in the meeting
             *
@@ -4279,17 +4229,11 @@ export namespace meeting {
             * @param appContentUrl - is the input URL which needs to be shared on to the stage
             */
         function shareAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void, appContentUrl: string): void;
-        /**
-            * Provides information related to app's in-meeting sharing capabilities
-            *
-            * @returns Promise resolved with sharing capability details or rejected with SdkError value
-            */
-        function getAppContentStageSharingCapabilities(): Promise<IAppContentStageSharingCapabilities>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.getAppContentStageSharingCapabilities meeting.getAppContentStageSharingCapabilities(): Promise\<IAppContentStageSharingCapabilities\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
-            * Provides information related to app's in-meeting sharing capabilities
+            * Provides information related app's in-meeting sharing capabilities
             *
             * @param callback - Callback contains 2 parameters, error and result.
             * error can either contain an error of type SdkError (error indication), or null (non-error indication)
@@ -4297,40 +4241,25 @@ export namespace meeting {
             * (indication of successful retrieval), or null (indication of failed retrieval)
             */
         function getAppContentStageSharingCapabilities(callback: (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void): void;
-        /**
-            * @hidden
-            * Hide from docs.
-            * ------------------------------------------
-            * Terminates current stage sharing session in meeting
-            *
-            * @returns Promise resolved indicating whether or not sharing successfully stopped or rejected with SdkError value
-            */
-        function stopSharingAppContentToStage(): Promise<boolean>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.stopSharingAppContentToStage meeting.stopSharingAppContentToStage(): Promise\<boolean\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * @hidden
             * Hide from docs.
-            * ------------------------------------------
             * Terminates current stage sharing session in meeting
-            * @param callback Callback contains 2 parameters, error and result.
+            *
+            * @param callback - Callback contains 2 parameters, error and result.
             * error can either contain an error of type SdkError (error indication), or null (non-error indication)
             * result can either contain a true boolean value (successful termination), or null (unsuccessful fetch)
-            * @internal
             */
         function stopSharingAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void): void;
-        /**
-            * Provides information related to current stage sharing state for app
-            *
-            * @returns Promise resolved to the App Content Stage Sharing State, or rejected with SdkError value
-            */
-        function getAppContentStageSharingState(): Promise<IAppContentStageSharingState>;
         /**
             * @deprecated
-            * As of 2.0.0-beta.1, please use {@link meeting.getAppContentStageSharingState meeting.getAppContentStageSharingState(): Promise\<IAppContentStageSharingState\>} instead.
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
             *
             * Provides information related to current stage sharing state for app
+            *
             * @param callback - Callback contains 2 parameters, error and result.
             * error can either contain an error of type SdkError (error indication), or null (non-error indication)
             * appContentStageSharingState can either contain an IAppContentStageSharingState object
@@ -4338,9 +4267,13 @@ export namespace meeting {
             */
         function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
         /**
+            * @deprecated
+            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+            *
             * Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
             * will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
             * at a time. A subsequent registration replaces an existing registration.
+            *
             * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
             */
         function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;