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

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.13";
+var version = "2.0.0-beta.6-dev.16";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2912,8 +2912,6 @@ var menus;
 
 /**
  * Namespace containing the set of APIs that support Teams-specific functionalities.
- *
- * @alpha
  */
 var teamsCore;
 (function (teamsCore) {
@@ -3372,6 +3370,9 @@ var pages;
      */
     function returnFocus(navigateForward) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('returnFocus', [navigateForward]);
     }
     pages.returnFocus = returnFocus;
@@ -3385,11 +3386,17 @@ var pages;
      */
     function registerFocusEnterHandler(handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('focusEnter', handler);
     }
     pages.registerFocusEnterHandler = registerFocusEnterHandler;
     function setCurrentFrame(frameInfo) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('setFrameContext', [frameInfo]);
     }
     pages.setCurrentFrame = setCurrentFrame;
@@ -3405,6 +3412,9 @@ var pages;
     function getConfig() {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.remove, FrameContexts.sidePanel);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             resolve(sendAndUnwrap('settings.getSettings'));
         });
     }
@@ -3421,6 +3431,9 @@ var pages;
     function navigateCrossDomain(url) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.remove, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             var errorMessage = 'Cross-origin navigation is only supported for URLs matching the pattern registered in the manifest.';
             resolve(sendAndHandleStatusAndReasonWithDefaultError('navigateCrossDomain', errorMessage, url));
         });
@@ -3438,6 +3451,9 @@ var pages;
     function navigateToApp(params) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             if (runtime.isLegacyTeams) {
                 resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsAppLink(params)));
             }
@@ -3454,6 +3470,9 @@ var pages;
      */
     function shareDeepLink(deepLinkParameters) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('shareDeepLink', [
             deepLinkParameters.subPageId,
             deepLinkParameters.subPageLabel,
@@ -3468,6 +3487,9 @@ var pages;
      */
     function registerFullScreenHandler(handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('fullScreenChange', handler);
     }
     pages.registerFullScreenHandler = registerFullScreenHandler;
@@ -3491,6 +3513,9 @@ var pages;
         function navigateToTab(tabInstance) {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 var errorMessage = 'Invalid internalTabInstanceId and/or channelId were/was provided';
                 resolve(sendAndHandleStatusAndReasonWithDefaultError('navigateToTab', errorMessage, tabInstance));
             });
@@ -3505,6 +3530,9 @@ var pages;
         function getTabInstances(tabInstanceParameters) {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndUnwrap('getTabInstances', tabInstanceParameters));
             });
         }
@@ -3517,6 +3545,9 @@ var pages;
         function getMruTabInstances(tabInstanceParameters) {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndUnwrap('getMruTabInstances', tabInstanceParameters));
             });
         }
@@ -3549,6 +3580,9 @@ var pages;
          */
         function setValidityState(validityState) {
             ensureInitialized(FrameContexts.settings, FrameContexts.remove);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('settings.setValidityState', [validityState]);
         }
         config.setValidityState = setValidityState;
@@ -3561,6 +3595,9 @@ var pages;
         function setConfig(instanceConfig) {
             return new Promise(function (resolve) {
                 ensureInitialized(FrameContexts.content, FrameContexts.settings, FrameContexts.sidePanel);
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndHandleStatusAndReason('settings.setSettings', instanceConfig));
             });
         }
@@ -3574,6 +3611,9 @@ var pages;
          */
         function registerOnSaveHandler(handler) {
             ensureInitialized(FrameContexts.settings);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             saveHandler = handler;
             handler && sendMessageToParent('registerHandler', ['save']);
         }
@@ -3587,6 +3627,9 @@ var pages;
          */
         function registerOnRemoveHandler(handler) {
             ensureInitialized(FrameContexts.remove, FrameContexts.settings);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             removeHandler = handler;
             handler && sendMessageToParent('registerHandler', ['remove']);
         }
@@ -3607,6 +3650,9 @@ var pages;
          */
         function registerChangeConfigHandler(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('changeSettings', handler);
         }
         config.registerChangeConfigHandler = registerChangeConfigHandler;
@@ -3697,6 +3743,9 @@ var pages;
         function navigateBack() {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 var errorMessage = 'Back navigation is not supported in the current client or context.';
                 resolve(sendAndHandleStatusAndReasonWithDefaultError('navigateBack', errorMessage));
             });
@@ -3710,6 +3759,10 @@ var pages;
          * @param handler The handler to invoke when the user presses their Team client's back button.
          */
         function registerBackButtonHandler(handler) {
+            ensureInitialized();
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             backButtonPressHandler = handler;
             handler && sendMessageToParent('registerHandler', ['backButton']);
         }
@@ -3737,6 +3790,9 @@ var pages;
          */
         function enterFullscreen() {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('enterFullscreen', []);
         }
         fullTrust.enterFullscreen = enterFullscreen;
@@ -3748,6 +3804,9 @@ var pages;
          */
         function exitFullscreen() {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('exitFullscreen', []);
         }
         fullTrust.exitFullscreen = exitFullscreen;
@@ -3771,6 +3830,9 @@ var pages;
          */
         function onClick(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('appButtonClick', handler);
         }
         appButton.onClick = onClick;
@@ -3781,6 +3843,9 @@ var pages;
          */
         function onHoverEnter(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('appButtonHoverEnter', handler);
         }
         appButton.onHoverEnter = onHoverEnter;
@@ -3791,6 +3856,9 @@ var pages;
          */
         function onHoverLeave(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('appButtonHoverLeave', handler);
         }
         appButton.onHoverLeave = onHoverLeave;
@@ -4415,9 +4483,6 @@ var logs;
 })(logs || (logs = {}));
 
 ;// CONCATENATED MODULE: ./src/private/interfaces.ts
-/**
- * @alpha
- */
 var NotificationTypes;
 (function (NotificationTypes) {
     NotificationTypes["fileDownloadStart"] = "fileDownloadStart";
@@ -4426,8 +4491,6 @@ var NotificationTypes;
 /**
  * @hidden
  * Hide from docs.
- * ------
- * @alpha
  */
 var ViewerActionTypes;
 (function (ViewerActionTypes) {
@@ -4439,8 +4502,7 @@ var ViewerActionTypes;
  * @hidden
  * Hide from docs.
  * ------
- * User setting changes that can be subscribed to,
- * @alpha
+ * User setting changes that can be subscribed to
  */
 var UserSettingTypes;
 (function (UserSettingTypes) {
@@ -4465,8 +4527,6 @@ var UserSettingTypes;
 /**
  * @hidden
  * Namespace to interact with the conversational subEntities inside the tab
- *
- * @alpha
  */
 var conversations;
 (function (conversations) {
@@ -4633,9 +4693,6 @@ function createTeamsDeepLinkForAppInstallDialog(appId) {
 
 
 
-/**
- * @alpha
- */
 var appInstallDialog;
 (function (appInstallDialog) {
     function openAppInstallDialog(openAPPInstallDialogParams) {
@@ -5053,10 +5110,6 @@ var __extends = (undefined && undefined.__extends) || (function () {
 
 
 
-/**
- * @deprecated
- * As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
- */
 var media;
 (function (media) {
     /**
@@ -5077,9 +5130,6 @@ var media;
     }());
     media.File = File;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
      *
      * @params callback - Callback will be called with an @see SdkError if there are any.
@@ -5356,9 +5406,6 @@ var media;
         ImageOutputFormats[ImageOutputFormats["PDF"] = 2] = "PDF";
     })(ImageOutputFormats = media.ImageOutputFormats || (media.ImageOutputFormats = {}));
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Select an attachment using camera/gallery
      *
      * @param mediaInputs - The input params to customize the media to be selected
@@ -5411,10 +5458,8 @@ var media;
     }
     media.selectMedia = selectMedia;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * View images using native image viewer
+     *
      * @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
      * @param callback - returns back error if encountered, returns null in case of success
      */
@@ -5438,10 +5483,8 @@ var media;
     }
     media.viewImages = viewImages;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Scan Barcode/QRcode using camera
+     *
      * @remarks
      * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
      *
@@ -5487,9 +5530,6 @@ var media;
 
 
 
-/**
- * @alpha
- */
 var location_location;
 (function (location_1) {
     function getLocation(props, callback) {
@@ -5542,10 +5582,6 @@ var location_location;
 
 
 
-/**
- * @deprecated
- * As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
- */
 var meeting;
 (function (meeting) {
     var MeetingType;
@@ -5563,9 +5599,6 @@ var meeting;
         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.
@@ -5583,9 +5616,6 @@ var meeting;
     }
     meeting.getIncomingClientAudioState = 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.
@@ -5602,9 +5632,6 @@ var meeting;
     }
     meeting.toggleIncomingClientAudio = toggleIncomingClientAudio;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * @hidden
      * Hide from docs
      *
@@ -5625,9 +5652,6 @@ var meeting;
     }
     meeting.getMeetingDetails = 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
      *
@@ -5646,9 +5670,6 @@ var meeting;
     }
     meeting.getAuthenticationTokenForAnonymousUser = getAuthenticationTokenForAnonymousUser;
     /**
-     * @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.
@@ -5664,9 +5685,6 @@ var meeting;
     }
     meeting.getLiveStreamState = getLiveStreamState;
     /**
-     * @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
@@ -5685,9 +5703,6 @@ var meeting;
     }
     meeting.requestStartLiveStreaming = requestStartLiveStreaming;
     /**
-     * @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
@@ -5704,9 +5719,6 @@ var meeting;
     }
     meeting.requestStopLiveStreaming = 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
@@ -5723,9 +5735,6 @@ var meeting;
     }
     meeting.registerLiveStreamChangedHandler = registerLiveStreamChangedHandler;
     /**
-     * @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.
@@ -5742,9 +5751,6 @@ var meeting;
     }
     meeting.shareAppContentToStage = shareAppContentToStage;
     /**
-     * @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.
@@ -5761,9 +5767,6 @@ var meeting;
     }
     meeting.getAppContentStageSharingCapabilities = getAppContentStageSharingCapabilities;
     /**
-     * @deprecated
-     * 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
@@ -5781,9 +5784,6 @@ var meeting;
     }
     meeting.stopSharingAppContentToStage = stopSharingAppContentToStage;
     /**
-     * @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.
@@ -5800,9 +5800,6 @@ var meeting;
     }
     meeting.getAppContentStageSharingState = 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.
@@ -5825,9 +5822,6 @@ var meeting;
 
 
 
-/**
- * @alpha
- */
 var monetization;
 (function (monetization) {
     /**
@@ -5870,9 +5864,6 @@ var monetization;
 
 
 
-/**
- * @alpha
- */
 var calendar;
 (function (calendar) {
     function openCalendarItem(openCalendarItemParams) {
@@ -5914,9 +5905,6 @@ var calendar;
 
 
 
-/**
- * @alpha
- */
 var mail;
 (function (mail) {
     function openMailItem(openMailItemParams) {
@@ -5964,9 +5952,6 @@ var mail;
 
 
 
-/**
- * @alpha
- */
 var people;
 (function (people_1) {
     /**
@@ -6000,6 +5985,9 @@ var people;
             if (!validatePeoplePickerInput(peoplePickerInputs)) {
                 throw { errorCode: ErrorCode.INVALID_ARGUMENTS };
             }
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             resolve(sendAndHandleSdkError('people.selectPeople', peoplePickerInputs));
         });
     }
@@ -6016,10 +6004,7 @@ var people;
 
 
 /**
- * Namespace to video extensibility of the SDK.
- *
- * @alpha
- *
+ * Namespace to video extensibility of the SDK
  */
 var video;
 (function (video) {
@@ -6036,7 +6021,7 @@ var video;
     var EffectChangeType;
     (function (EffectChangeType) {
         /**
-         * current video effect changed.
+         * current video effect changed
          */
         EffectChangeType[EffectChangeType["EffectChanged"] = 0] = "EffectChanged";
         /**
@@ -6045,7 +6030,7 @@ var video;
         EffectChangeType[EffectChangeType["EffectDisabled"] = 1] = "EffectDisabled";
     })(EffectChangeType = video.EffectChangeType || (video.EffectChangeType = {}));
     /**
-     * register to read the video frames in Permissions section.
+     * Register to read the video frames in Permissions section
      */
     function registerForVideoFrame(frameCallback, config) {
         ensureInitialized(FrameContexts.sidePanel);
@@ -6077,7 +6062,7 @@ var video;
     }
     video.notifySelectedVideoEffectChanged = notifySelectedVideoEffectChanged;
     /**
-     * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied.
+     * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied
      */
     function registerForVideoEffect(callback) {
         ensureInitialized(FrameContexts.sidePanel);
@@ -6088,14 +6073,14 @@ var video;
     }
     video.registerForVideoEffect = registerForVideoEffect;
     /**
-     * sending notification to Teams client finished the video frame processing, now Teams client can render this video frame
-     * or pass the video frame to next one in video pipeline.
+     * Sending notification to Teams client finished the video frame processing, now Teams client can render this video frame
+     * or pass the video frame to next one in video pipeline
      */
     function notifyVideoFrameProcessed() {
         sendMessageToParent('video.videoFrameProcessed');
     }
     /**
-     * sending error notification to Teams client.
+     * Sending error notification to Teams client
      */
     function notifyError(errorMessage) {
         sendMessageToParent('video.notifyError', [errorMessage]);
@@ -6113,9 +6098,6 @@ var video;
 
 
 
-/**
- * @alpha
- */
 var sharing;
 (function (sharing) {
     sharing.SharingAPIMessages = {
@@ -6229,9 +6211,6 @@ var stageView;
 
 
 
-/**
- * @alpha
- */
 var call;
 (function (call) {
     var CallModalities;
@@ -7403,9 +7382,6 @@ var legacy;
 
 
 
-/**
- * @alpha
- */
 var meetingRoom;
 (function (meetingRoom) {
     /**
@@ -7537,9 +7513,6 @@ var notifications;
 
 
 
-/**
- * @alpha
- */
 var remoteCamera;
 (function (remoteCamera) {
     /**
@@ -7771,8 +7744,6 @@ var remoteCamera;
 /**
  * @hidden
  * Namespace to interact with the application entities specific part of the SDK.
- *
- * @alpha
  */
 var appEntity;
 (function (appEntity_1) {
@@ -7788,8 +7759,6 @@ var appEntity;
      * @param callback Callback that will be triggered once the app entity information is available.
      *                 The callback takes two arguments: an SdkError in case something happened (i.e.
      *                 no permissions to execute the API) and the app entity configuration, if available
-     *
-     * @alpha
      */
     function selectAppEntity(threadId, categories, subEntityId, callback) {
         ensureInitialized(FrameContexts.content);
@@ -7839,6 +7808,9 @@ var teams;
      */
     function getTeamChannels(groupId, callback) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         if (!groupId) {
             throw new Error('[teams.getTeamChannels] groupId cannot be null or empty');
         }
@@ -7858,6 +7830,9 @@ var teams;
      */
     function refreshSiteUrl(threadId, callback) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         if (!threadId) {
             throw new Error('[teams.refreshSiteUrl] threadId cannot be null or empty');
         }