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

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.12";
+var version = "2.0.0-beta.6-dev.15";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1348,6 +1348,7 @@ var HostClientType;
     HostClientType["web"] = "web";
     HostClientType["android"] = "android";
     HostClientType["ios"] = "ios";
+    HostClientType["ipados"] = "ipados";
     /**
      * @deprecated
      * As of 2.0.0-beta.1, please use {@link teamsRoomsWindows} instead.
@@ -2572,6 +2573,9 @@ var dialog;
      */
     function open(urlDialogInfo, submitHandler, messageFromChildHandler) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         if (messageFromChildHandler) {
             registerHandler('messageForParent', messageFromChildHandler);
         }
@@ -2590,6 +2594,9 @@ var dialog;
      */
     function submit(result, appIds) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         // Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
         sendMessageToParent('tasks.completeTask', [result, appIds ? (Array.isArray(appIds) ? appIds : [appIds]) : []]);
     }
@@ -2606,6 +2613,9 @@ var dialog;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     message) {
         ensureInitialized(FrameContexts.task);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('messageForParent', [message]);
     }
     dialog.sendMessageToParentFromDialog = sendMessageToParentFromDialog;
@@ -2618,6 +2628,9 @@ var dialog;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     message) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('messageForChild', [message]);
     }
     dialog.sendMessageToDialog = sendMessageToDialog;
@@ -2631,6 +2644,9 @@ var dialog;
      */
     function registerOnMessageFromParent(listener) {
         ensureInitialized(FrameContexts.task);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         // We need to remove the original 'messageForChild'
         // handler since the original does not allow for post messages.
         // It is replaced by the user specified listener that is passed in.
@@ -2664,6 +2680,9 @@ var dialog;
          */
         function resize(dimensions) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('tasks.updateTask', [dimensions]);
         }
         update.resize = resize;
@@ -2693,6 +2712,9 @@ var dialog;
          */
         function open(botUrlDialogInfo, submitHandler, messageFromChildHandler) {
             ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             if (messageFromChildHandler) {
                 registerHandler('messageForParent', messageFromChildHandler);
             }
@@ -2890,8 +2912,6 @@ var menus;
 
 /**
  * Namespace containing the set of APIs that support Teams-specific functionalities.
- *
- * @alpha
  */
 var teamsCore;
 (function (teamsCore) {
@@ -3349,7 +3369,10 @@ var pages;
      * @param navigateForward - Determines the direction to focus in host.
      */
     function returnFocus(navigateForward) {
-        ensureInitialized(FrameContexts.content);
+        ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('returnFocus', [navigateForward]);
     }
     pages.returnFocus = returnFocus;
@@ -3363,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;
@@ -3383,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'));
         });
     }
@@ -3399,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));
         });
@@ -3416,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)));
             }
@@ -3432,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,
@@ -3446,6 +3487,9 @@ var pages;
      */
     function registerFullScreenHandler(handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('fullScreenChange', handler);
     }
     pages.registerFullScreenHandler = registerFullScreenHandler;
@@ -3469,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));
             });
@@ -3483,6 +3530,9 @@ var pages;
         function getTabInstances(tabInstanceParameters) {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndUnwrap('getTabInstances', tabInstanceParameters));
             });
         }
@@ -3495,6 +3545,9 @@ var pages;
         function getMruTabInstances(tabInstanceParameters) {
             return new Promise(function (resolve) {
                 ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndUnwrap('getMruTabInstances', tabInstanceParameters));
             });
         }
@@ -3527,6 +3580,9 @@ var pages;
          */
         function setValidityState(validityState) {
             ensureInitialized(FrameContexts.settings, FrameContexts.remove);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('settings.setValidityState', [validityState]);
         }
         config.setValidityState = setValidityState;
@@ -3539,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));
             });
         }
@@ -3552,6 +3611,9 @@ var pages;
          */
         function registerOnSaveHandler(handler) {
             ensureInitialized(FrameContexts.settings);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             saveHandler = handler;
             handler && sendMessageToParent('registerHandler', ['save']);
         }
@@ -3565,6 +3627,9 @@ var pages;
          */
         function registerOnRemoveHandler(handler) {
             ensureInitialized(FrameContexts.remove, FrameContexts.settings);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             removeHandler = handler;
             handler && sendMessageToParent('registerHandler', ['remove']);
         }
@@ -3585,6 +3650,9 @@ var pages;
          */
         function registerChangeConfigHandler(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('changeSettings', handler);
         }
         config.registerChangeConfigHandler = registerChangeConfigHandler;
@@ -3675,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));
             });
@@ -3688,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']);
         }
@@ -3715,6 +3790,9 @@ var pages;
          */
         function enterFullscreen() {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('enterFullscreen', []);
         }
         fullTrust.enterFullscreen = enterFullscreen;
@@ -3726,6 +3804,9 @@ var pages;
          */
         function exitFullscreen() {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             sendMessageToParent('exitFullscreen', []);
         }
         fullTrust.exitFullscreen = exitFullscreen;
@@ -3749,6 +3830,9 @@ var pages;
          */
         function onClick(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('appButtonClick', handler);
         }
         appButton.onClick = onClick;
@@ -3759,6 +3843,9 @@ var pages;
          */
         function onHoverEnter(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('appButtonHoverEnter', handler);
         }
         appButton.onHoverEnter = onHoverEnter;
@@ -3769,6 +3856,9 @@ var pages;
          */
         function onHoverLeave(handler) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             registerHandler('appButtonHoverLeave', handler);
         }
         appButton.onHoverLeave = onHoverLeave;
@@ -4393,9 +4483,6 @@ var logs;
 })(logs || (logs = {}));
 
 ;// CONCATENATED MODULE: ./src/private/interfaces.ts
-/**
- * @alpha
- */
 var NotificationTypes;
 (function (NotificationTypes) {
     NotificationTypes["fileDownloadStart"] = "fileDownloadStart";
@@ -4404,8 +4491,6 @@ var NotificationTypes;
 /**
  * @hidden
  * Hide from docs.
- * ------
- * @alpha
  */
 var ViewerActionTypes;
 (function (ViewerActionTypes) {
@@ -4417,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) {
@@ -4443,8 +4527,6 @@ var UserSettingTypes;
 /**
  * @hidden
  * Namespace to interact with the conversational subEntities inside the tab
- *
- * @alpha
  */
 var conversations;
 (function (conversations) {
@@ -4611,9 +4693,6 @@ function createTeamsDeepLinkForAppInstallDialog(appId) {
 
 
 
-/**
- * @alpha
- */
 var appInstallDialog;
 (function (appInstallDialog) {
     function openAppInstallDialog(openAPPInstallDialogParams) {
@@ -5465,9 +5544,6 @@ var media;
 
 
 
-/**
- * @alpha
- */
 var location_location;
 (function (location_1) {
     function getLocation(props, callback) {
@@ -5590,7 +5666,7 @@ var 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
+     * result can either contain a IMeetingDetailsResponse value, in case of a successful get or null when the get fails
      *
      * @internal
      */
@@ -5803,9 +5879,6 @@ var meeting;
 
 
 
-/**
- * @alpha
- */
 var monetization;
 (function (monetization) {
     /**
@@ -5848,9 +5921,6 @@ var monetization;
 
 
 
-/**
- * @alpha
- */
 var calendar;
 (function (calendar) {
     function openCalendarItem(openCalendarItemParams) {
@@ -5892,9 +5962,6 @@ var calendar;
 
 
 
-/**
- * @alpha
- */
 var mail;
 (function (mail) {
     function openMailItem(openMailItemParams) {
@@ -5942,9 +6009,6 @@ var mail;
 
 
 
-/**
- * @alpha
- */
 var people;
 (function (people_1) {
     /**
@@ -5978,6 +6042,9 @@ var people;
             if (!validatePeoplePickerInput(peoplePickerInputs)) {
                 throw { errorCode: ErrorCode.INVALID_ARGUMENTS };
             }
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
             resolve(sendAndHandleSdkError('people.selectPeople', peoplePickerInputs));
         });
     }
@@ -5994,10 +6061,7 @@ var people;
 
 
 /**
- * Namespace to video extensibility of the SDK.
- *
- * @alpha
- *
+ * Namespace to video extensibility of the SDK
  */
 var video;
 (function (video) {
@@ -6014,7 +6078,7 @@ var video;
     var EffectChangeType;
     (function (EffectChangeType) {
         /**
-         * current video effect changed.
+         * current video effect changed
          */
         EffectChangeType[EffectChangeType["EffectChanged"] = 0] = "EffectChanged";
         /**
@@ -6023,7 +6087,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);
@@ -6055,7 +6119,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);
@@ -6066,14 +6130,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]);
@@ -6091,9 +6155,6 @@ var video;
 
 
 
-/**
- * @alpha
- */
 var sharing;
 (function (sharing) {
     sharing.SharingAPIMessages = {
@@ -6207,9 +6268,6 @@ var stageView;
 
 
 
-/**
- * @alpha
- */
 var call;
 (function (call) {
     var CallModalities;
@@ -7381,9 +7439,6 @@ var legacy;
 
 
 
-/**
- * @alpha
- */
 var meetingRoom;
 (function (meetingRoom) {
     /**
@@ -7515,9 +7570,6 @@ var notifications;
 
 
 
-/**
- * @alpha
- */
 var remoteCamera;
 (function (remoteCamera) {
     /**
@@ -7589,6 +7641,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.getCapableParticipants] Callback cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('remoteCamera.getCapableParticipants', callback);
     }
     remoteCamera.getCapableParticipants = getCapableParticipants;
@@ -7612,6 +7667,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.requestControl] Callback cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('remoteCamera.requestControl', [participant], callback);
     }
     remoteCamera.requestControl = requestControl;
@@ -7632,6 +7690,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.sendControlCommand] Callback cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('remoteCamera.sendControlCommand', [ControlCommand], callback);
     }
     remoteCamera.sendControlCommand = sendControlCommand;
@@ -7648,6 +7709,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.terminateSession] Callback cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         sendMessageToParent('remoteCamera.terminateSession', callback);
     }
     remoteCamera.terminateSession = terminateSession;
@@ -7663,6 +7727,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.registerOnCapableParticipantsChangeHandler] Handler cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('remoteCamera.capableParticipantsChange', handler);
     }
     remoteCamera.registerOnCapableParticipantsChangeHandler = registerOnCapableParticipantsChangeHandler;
@@ -7678,6 +7745,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.registerOnErrorHandler] Handler cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('remoteCamera.handlerError', handler);
     }
     remoteCamera.registerOnErrorHandler = registerOnErrorHandler;
@@ -7693,6 +7763,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.registerOnDeviceStateChangeHandler] Handler cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('remoteCamera.deviceStateChange', handler);
     }
     remoteCamera.registerOnDeviceStateChangeHandler = registerOnDeviceStateChangeHandler;
@@ -7708,6 +7781,9 @@ var remoteCamera;
             throw new Error('[remoteCamera.registerOnSessionStatusChangeHandler] Handler cannot be null');
         }
         ensureInitialized(FrameContexts.sidePanel);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         registerHandler('remoteCamera.sessionStatusChange', handler);
     }
     remoteCamera.registerOnSessionStatusChangeHandler = registerOnSessionStatusChangeHandler;
@@ -7725,8 +7801,6 @@ var remoteCamera;
 /**
  * @hidden
  * Namespace to interact with the application entities specific part of the SDK.
- *
- * @alpha
  */
 var appEntity;
 (function (appEntity_1) {
@@ -7742,8 +7816,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);