@microsoft/teams-js 2.0.0-beta.3-dev.77 → 2.0.0-beta.3-dev.81

package/dist/MicrosoftTeams.d.ts

@@ -3442,6 +3442,20 @@ export namespace media {
                     * @hidden
                     * Hide from docs
                     * --------
+                    *
+                    * Function to notify the host client to programatically control the experience
+                    * @param mediaEvent indicates what the event that needs to be signaled to the host client
+                    * @returns A promise resolved promise
+                    */
+                protected notifyEventToHost(mediaEvent: MediaControllerEvent): Promise<void>;
+                /**
+                    * @hidden
+                    * Hide from docs
+                    * --------
+                    *
+                    * @deprecated
+                    * As of 2.0.0-beta.3, please use {@link media.MediaController.notifyEventToHost media.MediaController.notifyEventToHost(mediaEvent: MediaControllerEvent): Promise\<void\>} instead.
+                    *
                     * Function to notify the host client to programatically control the experience
                     * @param mediaEvent indicates what the event that needs to be signaled to the host client
                     * Optional; @param callback is used to send app if host client has successfully handled the notification event or not
@@ -3449,6 +3463,17 @@ export namespace media {
                 protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: (err?: SdkError) => void): void;
                 /**
                     * Function to programatically stop the ongoing media event
+                    *
+                    * @returns A resolved promise
+                    * */
+                stop(): Promise<void>;
+                /**
+                    *
+                    * Function to programatically stop the ongoing media event
+                    *
+                    * @deprecated
+                    * As of 2.0.0-beta.3, please use {@link media.MediaController.stop media.MediaController.stop(): Promise\<void\>} instead.
+                    *
                     * Optional; @param callback is used to send app if host client has successfully stopped the event or not
                     */
                 stop(callback?: (err?: SdkError) => void): void;

package/dist/MicrosoftTeams.js

@@ -1120,7 +1120,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.3-dev.77";
+var version = "2.0.0-beta.3-dev.81";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1748,7 +1748,7 @@ function ensureInitialized() {
  *
  * @internal
  */
-function isAPISupportedByPlatform(requiredVersion) {
+function isCurrentSDKVersionAtLeast(requiredVersion) {
     if (requiredVersion === void 0) { requiredVersion = defaultSDKVersionForCompatCheck; }
     var value = compareSDKVersions(GlobalVars.clientSupportedSDKVersion, requiredVersion);
     if (isNaN(value)) {
@@ -1768,22 +1768,21 @@ function isHostClientMobile() {
 /**
  * @hidden
  * Helper function which indicates if current API is supported on mobile or not.
- * @returns SdkError if host client is not android/ios or if the requiredVersion is not
+ * @throws SdkError if host client is not android/ios or if the requiredVersion is not
  *          supported by platform or not. Null is returned in case of success.
  *
  * @internal
  */
-function isApiSupportedOnMobile(requiredVersion) {
+function throwExceptionIfMobileApiIsNotSupported(requiredVersion) {
     if (requiredVersion === void 0) { requiredVersion = defaultSDKVersionForCompatCheck; }
     if (!isHostClientMobile()) {
         var notSupportedError = { errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM };
-        return notSupportedError;
+        throw notSupportedError;
     }
-    else if (!isAPISupportedByPlatform(requiredVersion)) {
+    else if (!isCurrentSDKVersionAtLeast(requiredVersion)) {
         var oldPlatformError = { errorCode: ErrorCode.OLD_PLATFORM };
-        return oldPlatformError;
+        throw oldPlatformError;
     }
-    return null;
 }
 /**
  * @hidden
@@ -4460,21 +4459,20 @@ function decodeAttachment(attachment, mimeType) {
 }
 /**
  * @hidden
- * Function returns null if the media call is supported on current mobile version, else SdkError.
- *
+ * Function throws an SdkError if the media call is not supported on current mobile version, else undefined.
+ * @throws an SdkError if the media call is not supported
  * @internal
  */
-function isMediaCallSupportedOnMobile(mediaInputs) {
+function throwExceptionIfMediaCallIsNotSupportedOnMobile(mediaInputs) {
     if (isMediaCallForVideoAndImageInputs(mediaInputs)) {
-        return isApiSupportedOnMobile(videoAndImageMediaAPISupportVersion);
+        throwExceptionIfMobileApiIsNotSupported(videoAndImageMediaAPISupportVersion);
     }
     else if (isMediaCallForNonFullScreenVideoMode(mediaInputs)) {
-        return isApiSupportedOnMobile(nonFullScreenVideoModeAPISupportVersion);
+        throwExceptionIfMobileApiIsNotSupported(nonFullScreenVideoModeAPISupportVersion);
     }
     else if (isMediaCallForImageOutputFormats(mediaInputs)) {
-        return isApiSupportedOnMobile(imageOutputFormatsAPISupportVersion);
+        throwExceptionIfMobileApiIsNotSupported(imageOutputFormatsAPISupportVersion);
     }
-    return null;
 }
 /**
  * @hidden
@@ -4667,7 +4665,7 @@ var media;
                 if (!GlobalVars.isFramelessWindow) {
                     throw { errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM };
                 }
-                if (!isAPISupportedByPlatform(captureImageMobileSupportVersion)) {
+                if (!isCurrentSDKVersionAtLeast(captureImageMobileSupportVersion)) {
                     throw { errorCode: ErrorCode.OLD_PLATFORM };
                 }
                 resolve(sendAndHandleSdkError('captureImage'));
@@ -4699,14 +4697,14 @@ var media;
             ensureInitialized(FrameContexts.content, FrameContexts.task);
             var wrappedFunction = function () {
                 return new Promise(function (resolve) {
-                    if (!isAPISupportedByPlatform(mediaAPISupportVersion)) {
+                    if (!isCurrentSDKVersionAtLeast(mediaAPISupportVersion)) {
                         throw { errorCode: ErrorCode.OLD_PLATFORM };
                     }
                     if (!validateGetMediaInputs(_this.mimeType, _this.format, _this.content)) {
                         throw { errorCode: ErrorCode.INVALID_ARGUMENTS };
                     }
                     // Call the new get media implementation via callbacks if the client version is greater than or equal to '2.0.0'
-                    if (isAPISupportedByPlatform(getMediaCallbackSupportVersion)) {
+                    if (isCurrentSDKVersionAtLeast(getMediaCallbackSupportVersion)) {
                         resolve(_this.getMediaViaCallback());
                     }
                     else {
@@ -4797,36 +4795,33 @@ var media;
         function MediaController(controllerCallback) {
             this.controllerCallback = controllerCallback;
         }
-        /**
-         * @hidden
-         * Hide from docs
-         * --------
-         * Function to notify the host client to programatically control the experience
-         * @param mediaEvent indicates what the event that needs to be signaled to the host client
-         * Optional; @param callback is used to send app if host client has successfully handled the notification event or not
-         */
         MediaController.prototype.notifyEventToHost = function (mediaEvent, callback) {
+            var _this = this;
             ensureInitialized(FrameContexts.content, FrameContexts.task);
-            var err = isApiSupportedOnMobile(nonFullScreenVideoModeAPISupportVersion);
-            if (err) {
-                if (callback) {
-                    callback(err);
-                }
-                return;
-            }
-            var params = { mediaType: this.getMediaType(), mediaControllerEvent: mediaEvent };
-            sendMessageToParent('media.controller', [params], function (err) {
+            return Promise.resolve()
+                .then(function () {
+                throwExceptionIfMobileApiIsNotSupported(nonFullScreenVideoModeAPISupportVersion);
+            })
+                .then(function () {
+                var params = { mediaType: _this.getMediaType(), mediaControllerEvent: mediaEvent };
+                sendMessageToParent('media.controller', [params], function (err) {
+                    if (callback) {
+                        callback(err);
+                    }
+                    else if (err) {
+                        throw err;
+                    }
+                });
+            })
+                .catch(function (err) {
                 if (callback) {
                     callback(err);
                 }
+                throw err;
             });
         };
-        /**
-         * Function to programatically stop the ongoing media event
-         * Optional; @param callback is used to send app if host client has successfully stopped the event or not
-         */
         MediaController.prototype.stop = function (callback) {
-            this.notifyEventToHost(MediaControllerEvent.StopRecording, callback);
+            return Promise.resolve(this.notifyEventToHost(MediaControllerEvent.StopRecording, callback));
         };
         return MediaController;
     }());
@@ -4916,13 +4911,10 @@ var media;
         ensureInitialized(FrameContexts.content, FrameContexts.task);
         var wrappedFunction = function () {
             return new Promise(function (resolve) {
-                if (!isAPISupportedByPlatform(mediaAPISupportVersion)) {
+                if (!isCurrentSDKVersionAtLeast(mediaAPISupportVersion)) {
                     throw { errorCode: ErrorCode.OLD_PLATFORM };
                 }
-                var err = isMediaCallSupportedOnMobile(mediaInputs);
-                if (err) {
-                    throw err;
-                }
+                throwExceptionIfMediaCallIsNotSupportedOnMobile(mediaInputs);
                 if (!validateSelectMediaInputs(mediaInputs)) {
                     throw { errorCode: ErrorCode.INVALID_ARGUMENTS };
                 }
@@ -4957,7 +4949,7 @@ var media;
         ensureInitialized(FrameContexts.content, FrameContexts.task);
         var wrappedFunction = function () {
             return new Promise(function (resolve) {
-                if (!isAPISupportedByPlatform(mediaAPISupportVersion)) {
+                if (!isCurrentSDKVersionAtLeast(mediaAPISupportVersion)) {
                     throw { errorCode: ErrorCode.OLD_PLATFORM };
                 }
                 if (!validateViewImagesInput(uriList)) {
@@ -5002,7 +4994,7 @@ var media;
                     GlobalVars.hostClientType === HostClientType.teamsDisplays) {
                     throw { errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM };
                 }
-                if (!isAPISupportedByPlatform(scanBarCodeAPIMobileSupportVersion)) {
+                if (!isCurrentSDKVersionAtLeast(scanBarCodeAPIMobileSupportVersion)) {
                     throw { errorCode: ErrorCode.OLD_PLATFORM };
                 }
                 if (!validateScanBarCodeInput(config)) {
@@ -5040,7 +5032,7 @@ var location_location;
     location_1.getLocation = getLocation;
     function getLocationHelper(props) {
         return new Promise(function (resolve) {
-            if (!isAPISupportedByPlatform(locationAPIsRequiredVersion)) {
+            if (!isCurrentSDKVersionAtLeast(locationAPIsRequiredVersion)) {
                 throw { errorCode: ErrorCode.OLD_PLATFORM };
             }
             if (!props) {
@@ -5056,7 +5048,7 @@ var location_location;
     location_1.showLocation = showLocation;
     function showLocationHelper(location) {
         return new Promise(function (resolve) {
-            if (!isAPISupportedByPlatform(locationAPIsRequiredVersion)) {
+            if (!isCurrentSDKVersionAtLeast(locationAPIsRequiredVersion)) {
                 throw { errorCode: ErrorCode.OLD_PLATFORM };
             }
             if (!location) {
@@ -5448,7 +5440,7 @@ var people;
     people_1.selectPeople = selectPeople;
     function selectPeopleHelper(peoplePickerInputs) {
         return new Promise(function (resolve) {
-            if (!isAPISupportedByPlatform(peoplePickerRequiredVersion)) {
+            if (!isCurrentSDKVersionAtLeast(peoplePickerRequiredVersion)) {
                 throw { errorCode: ErrorCode.OLD_PLATFORM };
             }
             if (!validatePeoplePickerInput(peoplePickerInputs)) {
@@ -6687,7 +6679,7 @@ var legacy;
                     GlobalVars.hostClientType === HostClientType.teamsRoomsAndroid ||
                     GlobalVars.hostClientType === HostClientType.teamsPhones ||
                     GlobalVars.hostClientType === HostClientType.teamsDisplays) &&
-                    !isAPISupportedByPlatform(getUserJoinedTeamsSupportedAndroidClientVersion)) {
+                    !isCurrentSDKVersionAtLeast(getUserJoinedTeamsSupportedAndroidClientVersion)) {
                     var oldPlatformError = { errorCode: ErrorCode.OLD_PLATFORM };
                     throw new Error(JSON.stringify(oldPlatformError));
                 }