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

package/dist/MicrosoftTeams.js

@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6-dev.6";
+var version = "2.0.0-beta.6-dev.7";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2367,7 +2367,6 @@ var runtime = {
         logs: undefined,
         mail: undefined,
         media: undefined,
-        meeting: undefined,
         meetingRoom: undefined,
         menus: undefined,
         monetization: undefined,
@@ -2406,7 +2405,6 @@ var teamsRuntimeConfig = {
         },
         logs: {},
         media: {},
-        meeting: {},
         meetingRoom: {},
         menus: {},
         monetization: {},
@@ -5439,10 +5437,9 @@ var location_location;
 
 
 
-
-
 /**
- * @alpha
+ * @deprecated
+ * As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
  */
 var meeting;
 (function (meeting) {
@@ -5455,102 +5452,156 @@ var meeting;
         MeetingType["Broadcast"] = "Broadcast";
         MeetingType["MeetNow"] = "MeetNow";
     })(MeetingType = meeting.MeetingType || (meeting.MeetingType = {}));
+    var CallType;
+    (function (CallType) {
+        CallType["OneOnOneCall"] = "oneOnOneCall";
+        CallType["GroupCall"] = "groupCall";
+    })(CallType = meeting.CallType || (meeting.CallType = {}));
+    /**
+     * @deprecated
+     * 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) {
+        if (!callback) {
+            throw new Error('[get incoming client audio state] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(getIncomingClientAudioStateHelper, callback);
+        sendMessageToParent('getIncomingClientAudioState', callback);
     }
     meeting.getIncomingClientAudioState = getIncomingClientAudioState;
-    function getIncomingClientAudioStateHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('getIncomingClientAudioState'));
-        });
-    }
+    /**
+     * @deprecated
+     * 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
+     * result can either contain the true/false value, incase of a successful toggle or null when the toggling fails
+     * result: True means incoming audio is muted and false means incoming audio is unmuted
+     */
     function toggleIncomingClientAudio(callback) {
+        if (!callback) {
+            throw new Error('[toggle incoming client audio] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(toggleIncomingClientAudioHelper, callback);
+        sendMessageToParent('toggleIncomingClientAudio', callback);
     }
     meeting.toggleIncomingClientAudio = toggleIncomingClientAudio;
-    function toggleIncomingClientAudioHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('toggleIncomingClientAudio'));
-        });
-    }
+    /**
+     * @deprecated
+     * 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 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 IMeetingDetailsResponse value, incase of a successful get or null when the get fails
+     *
+     * @internal
+     */
     function getMeetingDetails(callback) {
+        if (!callback) {
+            throw new Error('[get meeting details] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage, FrameContexts.settings, FrameContexts.content);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(getMeetingDetailsHelper, callback);
+        sendMessageToParent('meeting.getMeetingDetails', callback);
     }
     meeting.getMeetingDetails = getMeetingDetails;
-    function getMeetingDetailsHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.getMeetingDetails'));
-        });
-    }
+    /**
+     * @deprecated
+     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+     *
+     * @hidden
+     * 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
+     *
+     * @internal
+     */
     function getAuthenticationTokenForAnonymousUser(callback) {
+        if (!callback) {
+            throw new Error('[get Authentication Token For AnonymousUser] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(getAuthenticationTokenForAnonymousUserHelper, callback);
+        sendMessageToParent('meeting.getAuthenticationTokenForAnonymousUser', callback);
     }
     meeting.getAuthenticationTokenForAnonymousUser = getAuthenticationTokenForAnonymousUser;
-    function getAuthenticationTokenForAnonymousUserHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.getAuthenticationTokenForAnonymousUser'));
-        });
-    }
-    function isSupported() {
-        return runtime.supports.meeting ? true : false;
-    }
-    meeting.isSupported = isSupported;
+    /**
+     * @deprecated
+     * 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
+     *
+     * @param callback - Callback contains 2 parameters: error and liveStreamState.
+     * error can either contain an error of type SdkError, in case of an error, or null when get is successful
+     * liveStreamState can either contain a LiveStreamState value, or null when operation fails
+     */
     function getLiveStreamState(callback) {
-        ensureInitialized();
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(getLiveStreamStateHelper, callback);
+        if (!callback) {
+            throw new Error('[get live stream state] Callback cannot be null');
+        }
+        ensureInitialized(FrameContexts.sidePanel);
+        sendMessageToParent('meeting.getLiveStreamState', callback);
     }
     meeting.getLiveStreamState = getLiveStreamState;
-    function getLiveStreamStateHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.getLiveStreamState'));
-        });
-    }
     /**
-     * @hidden
-     * This function is the overloaded implementation of requestStartLiveStreaming.
-     * Since the method signatures of the v1 callback and v2 promise differ in the type of the first parameter,
-     * we need to do an extra check to know the typeof the @param1 to set the proper arguments of the utility function.
-     * @param param1
-     * @param param2
-     * @param param3
-     * @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
+     * @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
+     * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
+     *
+     * @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
      */
-    function requestStartLiveStreaming(param1, param2, param3) {
-        var _a, _b;
-        ensureInitialized(FrameContexts.sidePanel);
-        var streamUrl;
-        var streamKey;
-        var callback;
-        if (typeof param1 === 'function') {
-            // Legacy code, with callbacks.
-            _a = [param1, param2, param3], callback = _a[0], streamUrl = _a[1], streamKey = _a[2];
-        }
-        else if (typeof param1 === 'string') {
-            _b = [param1, param2], streamUrl = _b[0], streamKey = _b[1];
+    function requestStartLiveStreaming(callback, streamUrl, streamKey) {
+        if (!callback) {
+            throw new Error('[request start live streaming] Callback cannot be null');
         }
-        return callCallbackWithSdkErrorFromPromiseAndReturnPromise(requestStartLiveStreamingHelper, callback, streamUrl, streamKey);
+        ensureInitialized(FrameContexts.sidePanel);
+        sendMessageToParent('meeting.requestStartLiveStreaming', [streamUrl, streamKey], callback);
     }
     meeting.requestStartLiveStreaming = requestStartLiveStreaming;
-    function requestStartLiveStreamingHelper(streamUrl, streamKey) {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.requestStartLiveStreaming', streamUrl, streamKey));
-        });
-    }
+    /**
+     * @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 stopped at the given streaming url
+     *
+     * @remarks
+     * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
+     *
+     * @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
+     */
     function requestStopLiveStreaming(callback) {
+        if (!callback) {
+            throw new Error('[request stop live streaming] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel);
-        return callCallbackWithSdkErrorFromPromiseAndReturnPromise(requestStopLiveStreamingHelper, callback);
+        sendMessageToParent('meeting.requestStopLiveStreaming', callback);
     }
     meeting.requestStopLiveStreaming = requestStopLiveStreaming;
-    function requestStopLiveStreamingHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.requestStopLiveStreaming'));
-        });
-    }
     /**
+     * @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
@@ -5567,81 +5618,90 @@ var meeting;
     }
     meeting.registerLiveStreamChangedHandler = registerLiveStreamChangedHandler;
     /**
-     * This function is the overloaded implementation of shareAppContentToStage.
-     * Since the method signatures of the v1 callback and v2 promise differ in the type of the first parameter,
-     * we need to do an extra check to know the typeof the @param1 to set the proper arguments of the utility function.
-     * @param param1
-     * @param param2
-     * @returns Promise resolved indicating whether or not the share was successful or rejected with SdkError value
+     * @deprecated
+     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+     *
+     * Allows an app to share contents in the meeting
+     *
+     * @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 share is successful
+     * result can either contain a true value, incase of a successful share or null when the share fails
+     * @param appContentUrl - is the input URL which needs to be shared on to the stage
      */
-    function shareAppContentToStage(param1, param2) {
-        var _a;
-        ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        var appContentUrl;
-        var callback;
-        if (typeof param1 === 'function') {
-            // Legacy callback
-            _a = [param1, param2], callback = _a[0], appContentUrl = _a[1];
-        }
-        else {
-            appContentUrl = param1;
+    function shareAppContentToStage(callback, appContentUrl) {
+        if (!callback) {
+            throw new Error('[share app content to stage] Callback cannot be null');
         }
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(shareAppContentToStageHelper, callback, appContentUrl);
+        ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
+        sendMessageToParent('meeting.shareAppContentToStage', [appContentUrl], callback);
     }
     meeting.shareAppContentToStage = shareAppContentToStage;
     /**
-     * @hidden
-     * Helper method to generate and return a promise for shareAppContentToStage
-     * @param appContentUrl
-     * @returns
+     * @deprecated
+     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+     *
+     * 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)
+     * appContentStageSharingCapabilities can either contain an IAppContentStageSharingCapabilities object
+     * (indication of successful retrieval), or null (indication of failed retrieval)
      */
-    function shareAppContentToStageHelper(appContentUrl) {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.shareAppContentToStage', appContentUrl));
-        });
-    }
     function getAppContentStageSharingCapabilities(callback) {
+        if (!callback) {
+            throw new Error('[get app content stage sharing capabilities] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(getAppContentStageSharingCapabilitiesHelper, callback);
+        sendMessageToParent('meeting.getAppContentStageSharingCapabilities', callback);
     }
     meeting.getAppContentStageSharingCapabilities = getAppContentStageSharingCapabilities;
     /**
+     * @deprecated
+     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
+     *
      * @hidden
-     * @returns
+     * Hide from docs.
+     * Terminates current stage sharing session in meeting
+     *
+     * @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)
      */
-    function getAppContentStageSharingCapabilitiesHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.getAppContentStageSharingCapabilities'));
-        });
-    }
     function stopSharingAppContentToStage(callback) {
+        if (!callback) {
+            throw new Error('[stop sharing app content to stage] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(stopSharingAppContentToStageHelper, callback);
+        sendMessageToParent('meeting.stopSharingAppContentToStage', callback);
     }
     meeting.stopSharingAppContentToStage = stopSharingAppContentToStage;
     /**
-     * @hidden
-     * @returns
+     * @deprecated
+     * 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
+     * (indication of successful retrieval), or null (indication of failed retrieval)
      */
-    function stopSharingAppContentToStageHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.stopSharingAppContentToStage'));
-        });
-    }
     function getAppContentStageSharingState(callback) {
+        if (!callback) {
+            throw new Error('[get app content stage sharing state] Callback cannot be null');
+        }
         ensureInitialized(FrameContexts.sidePanel, FrameContexts.meetingStage);
-        return callCallbackWithErrorOrResultOrNullFromPromiseAndReturnPromise(getAppContentStageSharingStateHelper, callback);
+        sendMessageToParent('meeting.getAppContentStageSharingState', callback);
     }
     meeting.getAppContentStageSharingState = getAppContentStageSharingState;
-    function getAppContentStageSharingStateHelper() {
-        return new Promise(function (resolve) {
-            resolve(sendAndHandleSdkError('meeting.getAppContentStageSharingState'));
-        });
-    }
     /**
+     * @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) {