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

package/dist/MicrosoftTeams.js

@@ -1076,7 +1076,6 @@ __webpack_require__.d(__webpack_exports__, {
   "getTabInstances": () => (/* reexport */ getTabInstances),
   "initialize": () => (/* reexport */ initialize),
   "initializeWithFrameContext": () => (/* reexport */ initializeWithFrameContext),
-  "legacy": () => (/* reexport */ legacy),
   "location": () => (/* reexport */ location_location),
   "logs": () => (/* reexport */ logs),
   "mail": () => (/* reexport */ mail),
@@ -1122,7 +1121,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.7-dev.5";
+var version = "2.0.0-beta.7-dev.8";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1351,7 +1350,7 @@ var HostClientType;
     HostClientType["ipados"] = "ipados";
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link teamsRoomsWindows} instead.
+     * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
      */
     HostClientType["rigel"] = "rigel";
     HostClientType["surfaceHub"] = "surfaceHub";
@@ -1412,7 +1411,7 @@ var DialogDimension;
 
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link DialogDimension} instead.
+ * As of 2.0.0, please use {@link DialogDimension} instead.
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 var TaskModuleDimension = DialogDimension;
@@ -1856,7 +1855,7 @@ function uploadCustomApp(manifestBlob, onComplete) {
 /**
  * @hidden
  * Internal use only
- * Sends a custom action MessageRequest to Teams or parent window
+ * Sends a custom action MessageRequest to host or parent window
  *
  * @param actionName - Specifies name of the custom action to be sent
  * @param args - Specifies additional arguments passed to the action
@@ -2987,6 +2986,11 @@ var teamsCore;
         handlers_registerBeforeUnloadHandler(handler);
     }
     teamsCore.registerBeforeUnloadHandler = registerBeforeUnloadHandler;
+    /**
+     * Checks if teamsCore capability is supported by the host
+     * @returns true if the teamsCore capability is enabled in runtime.supports.teamsCore and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.teamsCore ? true : false;
     }
@@ -3419,8 +3423,8 @@ function transformLegacyContextToAppContext(legacyContext) {
 var pages;
 (function (pages) {
     /**
-     * Return focus to the host. Will move focus forward or backward based on where the app container falls in
-     * the F6/Tab accessiblity loop in the host.
+     * Return focus to the host. Will move focus forward or backward based on where the application container falls in
+     * the F6/tab order in the host.
      * @param navigateForward - Determines the direction to focus in host.
      */
     function returnFocus(navigateForward) {
@@ -3434,9 +3438,9 @@ var pages;
     /**
      * @hidden
      *
-     * Registers a handler when focus needs to be passed from teams to the place of choice on app.
+     * Registers a handler for specifying focus when it passes from the host to the application.
      *
-     * @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
+     * @param handler - The handler for placing focus within the application.
      *
      * @internal
      */
@@ -3467,7 +3471,7 @@ var pages;
      *
      * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
      *  user clicks 'Go To Website'
-     * @param callback - An optional user-set callback that is executed once the app has finished initialization.
+     * @param callback - An optional callback that is executed once the application has finished initialization.
      * @param validMessageOrigins - An optional list of cross-frame message origins. They must have
      * https: protocol otherwise they will be ignored. Example: https:www.example.com
      */
@@ -3494,7 +3498,7 @@ var pages;
      * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
      * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
      * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
-     * than the current one in a way that keeps the app informed of the change and allows the SDK to
+     * than the current one in a way that keeps the application informed of the change and allows the SDK to
      * continue working.
      * @param url - The URL to navigate the frame to.
      * @returns Promise that resolves when the navigation has completed.
@@ -3511,12 +3515,12 @@ var pages;
     }
     pages.navigateCrossDomain = navigateCrossDomain;
     /**
-     * Navigate to the given App ID and Page ID, with optional parameters for a WebURL (if the app cannot
-     * be navigated to, such as if it is not installed), Channel ID (for apps installed as a channel tab), and
-     * Sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
-     * a deep link with the above data, but does not require the app to build a URL or worry about different
+     * Navigate to the given application ID and page ID, with optional parameters for a WebURL (if the application
+     * cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab),
+     * and sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
+     * a deep link with the above data, but does not require the application to build a URL or worry about different
      * deep link formats for different hosts.
-     * @param params Parameters for the navigation
+     * @param params - Parameters for the navigation
      * @returns a promise that will resolve if the navigation was successful
      */
     function navigateToApp(params) {
@@ -3565,7 +3569,7 @@ var pages;
     }
     pages.registerFullScreenHandler = registerFullScreenHandler;
     /**
-     * Checks if the current application host supports the pages capability
+     * Checks if the pages capability is supported by the host
      * @returns true if the pages capability is enabled in runtime.supports.pages and
      * false if it is disabled
      */
@@ -3574,13 +3578,14 @@ var pages;
     }
     pages.isSupported = isSupported;
     /**
-     * Namespace to interact with the teams specific part of the SDK.
+     * Provides APIs for querying and navigating between contextual tabs of an application. Unlike personal tabs,
+     * contextual tabs are pages associated with a specific context, such as channel or chat.
      */
     var tabs;
     (function (tabs) {
         /**
-         * Navigates the hosted app to the specified tab instance.
-         * @param tabInstance The tab instance to navigate to.
+         * Navigates the hosted application to the specified tab instance.
+         * @param tabInstance - The destination tab instance.
          * @returns Promise that resolves when the navigation has completed.
          */
         function navigateToTab(tabInstance) {
@@ -3595,9 +3600,9 @@ var pages;
         }
         tabs.navigateToTab = navigateToTab;
         /**
-         * Allows an app to retrieve for this user tabs that are owned by this app.
-         * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
-         * @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
+         * Retrieves application tabs for the current user.
+         * If no TabInstanceParameters are passed, the application defaults to favorite teams and favorite channels.
+         * @param tabInstanceParameters - An optional set of flags that specify whether to scope call to favorite teams or channels.
          * @returns Promise that resolves with the {@link TabInformation}. Contains information for the user's tabs that are owned by this application {@link TabInstance}.
          */
         function getTabInstances(tabInstanceParameters) {
@@ -3611,8 +3616,8 @@ var pages;
         }
         tabs.getTabInstances = getTabInstances;
         /**
-         * Allows an app to retrieve the most recently used tabs for this user.
-         * @param tabInstanceParameters OPTIONAL Ignored, kept for future use.
+         * Retrieves the most recently used application tabs for the current user.
+         * @param tabInstanceParameters - An optional set of flags. Note this is currently ignored and kept for future use.
          * @returns Promise that resolves with the {@link TabInformation}. Contains information for the users' most recently used tabs {@link TabInstance}.
          */
         function getMruTabInstances(tabInstanceParameters) {
@@ -3626,7 +3631,7 @@ var pages;
         }
         tabs.getMruTabInstances = getMruTabInstances;
         /**
-         * Checks if the current application host supports the pages.tab capability
+         * Checks if the pages.tab capability is supported by the host
          * @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
          * false if it is disabled
          */
@@ -3636,8 +3641,8 @@ var pages;
         tabs.isSupported = isSupported;
     })(tabs = pages.tabs || (pages.tabs = {}));
     /**
-     * Namespace to interact with the config-specific part of the SDK.
-     * This object is usable only on the config frame.
+     * Provides APIs to interact with the configuration-specific part of the SDK.
+     * This object is usable only on the configuration frame.
      */
     var config;
     (function (config) {
@@ -3656,9 +3661,9 @@ var pages;
         }
         config.initialize = initialize;
         /**
-         * Sets the validity state for the config.
-         * The initial value is false, so the user cannot save the config until this is called with true.
-         * @param validityState Indicates whether the save or remove button is enabled for the user.
+         * Sets the validity state for the configuration.
+         * The initial value is false, so the user cannot save the configuration until this is called with true.
+         * @param validityState - Indicates whether the save or remove button is enabled for the user.
          */
         function setValidityState(validityState) {
             ensureInitialized(FrameContexts.settings, FrameContexts.remove);
@@ -3669,9 +3674,9 @@ var pages;
         }
         config.setValidityState = setValidityState;
         /**
-         * Sets the config for the current instance.
+         * Sets the configuration for the current instance.
          * This is an asynchronous operation; calls to getConfig are not guaranteed to reflect the changed state.
-         * @param instanceConfig The desired config for this instance.
+         * @param instanceConfig - The desired configuration for this instance.
          * @returns Promise that resolves when the operation has completed.
          */
         function setConfig(instanceConfig) {
@@ -3685,11 +3690,11 @@ var pages;
         }
         config.setConfig = setConfig;
         /**
-         * Registers a handler for when the user attempts to save the settings. This handler should be used
+         * Registers a handler for when the user attempts to save the configuration. This handler should be used
          * to create or update the underlying resource powering the content.
          * The object passed to the handler must be used to notify whether to proceed with the save.
          * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
-         * @param handler The handler to invoke when the user selects the save button.
+         * @param handler - The handler to invoke when the user selects the Save button.
          */
         function registerOnSaveHandler(handler) {
             ensureInitialized(FrameContexts.settings);
@@ -3705,7 +3710,7 @@ var pages;
          * to remove the underlying resource powering the content.
          * The object passed to the handler must be used to indicate whether to proceed with the removal.
          * Only one handler may be registered at a time. Subsequent registrations will override the first.
-         * @param handler The handler to invoke when the user selects the remove button.
+         * @param handler - The handler to invoke when the user selects the Remove button.
          */
         function registerOnRemoveHandler(handler) {
             ensureInitialized(FrameContexts.remove, FrameContexts.settings);
@@ -3728,7 +3733,7 @@ var pages;
         }
         /**
          * Registers a handler for when the tab configuration is changed by the user
-         * @param handler The handler to invoke when the user click on Settings.
+         * @param handler - The handler to invoke when the user clicks on Settings.
          */
         function registerChangeConfigHandler(handler) {
             ensureInitialized(FrameContexts.content);
@@ -3800,7 +3805,7 @@ var pages;
             return RemoveEventImpl;
         }());
         /**
-         * Checks if the current application host supports the pages.config capability
+         * Checks if the pages.config capability is supported by the host
          * @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
          * false if it is disabled
          */
@@ -3810,7 +3815,7 @@ var pages;
         config.isSupported = isSupported;
     })(config = pages.config || (pages.config = {}));
     /**
-     * Namespace to interact with the back-stack part of the SDK.
+     * Provides APIs for handling the user's navigational history.
      */
     var backStack;
     (function (backStack) {
@@ -3820,8 +3825,7 @@ var pages;
         }
         backStack._initialize = _initialize;
         /**
-         * Navigates back in the hosted app. See registerBackButtonHandler for more information on when
-         * it's appropriate to use this method.
+         * Navigates back in the hosted application. See {@link pages.backStack.registerBackButtonHandler} for notes on usage.
          * @returns Promise that resolves when the navigation has completed.
          */
         function navigateBack() {
@@ -3836,11 +3840,11 @@ var pages;
         }
         backStack.navigateBack = navigateBack;
         /**
-         * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
-         * navigation stack should use this handler to navigate the user back within their frame. If an app finds
+         * Registers a handler for user presses of the host client's back button. Experiences that maintain an internal
+         * navigation stack should use this handler to navigate the user back within their frame. If an application finds
          * that after running its back button handler it cannot handle the event it should call the navigateBack
-         * method to ask the Teams client to handle it instead.
-         * @param handler The handler to invoke when the user presses their Team client's back button.
+         * method to ask the host client to handle it instead.
+         * @param handler - The handler to invoke when the user presses the host client's back button.
          */
         function registerBackButtonHandler(handler) {
             ensureInitialized();
@@ -3857,7 +3861,7 @@ var pages;
             }
         }
         /**
-         * Checks if the current application host supports the pages.backStack capability
+         * Checks if the pages.backStack capability is supported by the host
          * @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
          * false if it is disabled
          */
@@ -3870,7 +3874,7 @@ var pages;
      * @hidden
      * Hide from docs
      * ------
-     * Namespace to interact with the full-trust part of the SDK. Limited to 1P apps
+     * Provides APIs to interact with the full-trust part of the SDK. Limited to 1P applications
      */
     var fullTrust;
     (function (fullTrust) {
@@ -3906,7 +3910,7 @@ var pages;
          * @hidden
          * Hide from docs
          * ------
-         * Checks if the current application host supports the pages.fullTrust capability
+         * Checks if the pages.fullTrust capability is supported by the host
          * @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
          * false if it is disabled
          */
@@ -3916,7 +3920,7 @@ var pages;
         fullTrust.isSupported = isSupported;
     })(fullTrust = pages.fullTrust || (pages.fullTrust = {}));
     /**
-     * Namespace to interact with the app button part of the SDK.
+     * Provides APIs to interact with the app button part of the SDK.
      */
     var appButton;
     (function (appButton) {
@@ -3960,7 +3964,7 @@ var pages;
         }
         appButton.onHoverLeave = onHoverLeave;
         /**
-         * Checks if pages.appButton capability is supported currently
+         * Checks if pages.appButton capability is supported by the host
          * @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
          * false if it is disabled
          */
@@ -6133,6 +6137,8 @@ var video;
     })(EffectChangeType = video.EffectChangeType || (video.EffectChangeType = {}));
     /**
      * Register to read the video frames in Permissions section
+     * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+     * @param config - VideoFrameConfig to customize generated video frame parameters
      */
     function registerForVideoFrame(frameCallback, config) {
         ensureInitialized(FrameContexts.sidePanel);
@@ -6148,9 +6154,9 @@ var video;
     }
     video.registerForVideoFrame = registerForVideoFrame;
     /**
-     * video extension should call this to notify Teams Client current selected effect parameter changed.
-     * If it's pre-meeting, Teams client will call videoEffectCallback immediately then use the videoEffect.
-     * in-meeting scenario, we will call videoEffectCallback when apply button clicked.
+     * video extension should call this to notify host client that the current selected effect parameter changed.
+     * If it's pre-meeting, host client will call videoEffectCallback immediately then use the videoEffect.
+     * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
      *
      * @param effectChangeType - the effect change type.
      * @param effectId - Newly selected effect id.
@@ -6164,7 +6170,8 @@ 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, host client uses this to notify the video extension the new video effect will by applied
+     * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
      */
     function registerForVideoEffect(callback) {
         ensureInitialized(FrameContexts.sidePanel);
@@ -6175,18 +6182,24 @@ var video;
     }
     video.registerForVideoEffect = registerForVideoEffect;
     /**
-     * Sending notification to Teams client finished the video frame processing, now Teams client can render this video frame
+     * Sending notification to host client finished the video frame processing, now host 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 host client
+     * @param errorMessage - The error message that will be sent to the host
      */
     function notifyError(errorMessage) {
         sendMessageToParent('video.notifyError', [errorMessage]);
     }
+    /**
+     * Checks if video capability is supported by the host
+     * @returns true if the video capability is enabled in runtime.supports.video and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.video ? true : false;
     }
@@ -6355,31 +6368,31 @@ var call;
 
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link app} namespace instead.
+ * As of 2.0.0, please use {@link app} namespace instead.
  */
 var appInitialization;
 (function (appInitialization) {
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.Messages} instead.
+     * As of 2.0.0, please use {@link app.Messages} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.Messages = app_app.Messages;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.FailedReason} instead.
+     * As of 2.0.0, please use {@link app.FailedReason} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.FailedReason = app_app.FailedReason;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.ExpectedFailureReason} instead.
+     * As of 2.0.0, please use {@link app.ExpectedFailureReason} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.ExpectedFailureReason = app_app.ExpectedFailureReason;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
+     * As of 2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
      *
      * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
      */
@@ -6389,7 +6402,7 @@ var appInitialization;
     appInitialization.notifyAppLoaded = notifyAppLoaded;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
+     * As of 2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
      *
      * Notifies the frame that app initialization is successful and is ready for user interaction.
      */
@@ -6399,7 +6412,7 @@ var appInitialization;
     appInitialization.notifySuccess = notifySuccess;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
+     * As of 2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
      *
      * Notifies the frame that app initialization has failed and to show an error page in its place.
      * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
@@ -6411,7 +6424,7 @@ var appInitialization;
     appInitialization.notifyFailure = notifyFailure;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
+     * As of 2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
      *
      * Notifies the frame that app initialized with some expected errors.
      * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
@@ -6431,7 +6444,7 @@ var appInitialization;
 
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
+ * As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
  *
  * Initializes the library. This must be called before any other SDK calls
  * but after the frame is loaded successfully.
@@ -6448,7 +6461,7 @@ function initialize(callback, validMessageOrigins) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
+ * As of 2.0.0, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
  *
  * @hidden
  * Hide from docs.
@@ -6463,7 +6476,7 @@ function _initialize(hostWindow) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link app._uninitialize app._uninitialize(): void} instead.
+ * As of 2.0.0, please use {@link app._uninitialize app._uninitialize(): void} instead.
  *
  * @hidden
  * Hide from docs.
@@ -6477,7 +6490,7 @@ function _uninitialize() {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
+ * As of 2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
  *
  * Enable print capability to support printing page using Ctrl+P and cmd+P
  */
@@ -6486,7 +6499,7 @@ function enablePrintCapability() {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link teamsCore.print teamsCore.print(): void} instead.
+ * As of 2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
  *
  * Default print handler
  */
@@ -6495,7 +6508,7 @@ function print() {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
+ * As of 2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
  *
  * Retrieves the current context the frame is running in.
  *
@@ -6511,7 +6524,7 @@ function getContext(callback) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
+ * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
  *
  * Registers a handler for theme changes.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -6523,7 +6536,7 @@ function registerOnThemeChangeHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
+ * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
  *
  * Registers a handler for changes from or to full-screen view for a tab.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -6535,7 +6548,7 @@ function registerFullScreenHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
  *
  * Registers a handler for clicking the app button.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -6547,7 +6560,7 @@ function registerAppButtonClickHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
  *
  * Registers a handler for entering hover of the app button.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -6559,7 +6572,7 @@ function registerAppButtonHoverEnterHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
  *
  * Registers a handler for exiting hover of the app button.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -6571,7 +6584,7 @@ function registerAppButtonHoverLeaveHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
+ * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
  *
  * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
  * navigation stack should use this handler to navigate the user back within their frame. If an app finds
@@ -6585,7 +6598,7 @@ function registerBackButtonHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
+ * As of 2.0.0, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
  *
  * @hidden
  * Registers a handler to be called when the page has been requested to load.
@@ -6597,7 +6610,7 @@ function registerOnLoadHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
+ * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
  *
  * @hidden
  * Registers a handler to be called before the page is unloaded.
@@ -6610,7 +6623,7 @@ function registerBeforeUnloadHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.3, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
+ * As of 2.0.0, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
  *
  * @hidden
  * Registers a handler when focus needs to be passed from teams to the place of choice on app.
@@ -6622,7 +6635,7 @@ function registerFocusEnterHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
  *
  * Registers a handler for when the user reconfigurated tab.
  *
@@ -6633,7 +6646,7 @@ function registerEnterSettingsHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
+ * As of 2.0.0, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
  *
  * Allows an app to retrieve for this user tabs that are owned by this app.
  * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
@@ -6649,7 +6662,7 @@ function getTabInstances(callback, tabInstanceParameters) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
+ * As of 2.0.0, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
  *
  * Allows an app to retrieve the most recently used tabs for this user.
  *
@@ -6664,7 +6677,7 @@ function getMruTabInstances(callback, tabInstanceParameters) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.3, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
+ * As of 2.0.0, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
  *
  * Shares a deep link that a user can use to navigate back to a specific state in this page.
  *
@@ -6679,7 +6692,7 @@ function shareDeepLink(deepLinkParameters) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.3, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
+ * As of 2.0.0, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
  *
  * Execute deep link API.
  *
@@ -6698,7 +6711,7 @@ function executeDeepLink(deepLink, onComplete) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
+ * As of 2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
  *
  * Set the current Frame Context
  *
@@ -6709,7 +6722,7 @@ function setFrameContext(frameContext) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
+ * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
  *
  * Initilize with FrameContext
  *
@@ -6722,7 +6735,9 @@ function initializeWithFrameContext(frameContext, callback, validMessageOrigins)
     pages.initializeWithFrameContext(frameContext, callback, validMessageOrigins);
 }
 /**
- * Transforms the app.Context object received to TeamsJS Context
+ * Transforms the app.Context object received to the legacy global Context object
+ * @param appContext - The app.Context object to be transformed
+ * @returns The transformed legacy global Context object
  */
 function transformAppContextToLegacyContext(appContext) {
     var context = {
@@ -6808,7 +6823,7 @@ function transformAppContextToLegacyContext(appContext) {
  */
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
+ * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
  *
  * Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
  *
@@ -6819,7 +6834,7 @@ function returnFocus(navigateForward) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
+ * As of 2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
  *
  * Navigates the Microsoft Teams app to the specified tab instance.
  *
@@ -6839,7 +6854,7 @@ function navigateToTab(tabInstance, onComplete) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
+ * As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
  *
  * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
  * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
@@ -6863,7 +6878,7 @@ function navigateCrossDomain(url, onComplete) {
 }
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
+ * As of 2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
  *
  * Navigates back in the Teams client.
  * See registerBackButtonHandler for more information on when it's appropriate to use this method.
@@ -6889,7 +6904,7 @@ function navigateBack(onComplete) {
 
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link pages.config} namespace instead.
+ * As of 2.0.0, please use {@link pages.config} namespace instead.
  *
  * Namespace to interact with the settings-specific part of the SDK.
  * This object is usable only on the settings frame.
@@ -6898,7 +6913,7 @@ var settings;
 (function (settings) {
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
+     * As of 2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
      *
      * Sets the validity state for the settings.
      * The initial value is false, so the user cannot save the settings until this is called with true.
@@ -6911,7 +6926,7 @@ var settings;
     settings.setValidityState = setValidityState;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
+     * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
      *
      * Gets the settings for the current instance.
      *
@@ -6926,7 +6941,7 @@ var settings;
     settings.getSettings = getSettings;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
+     * As of 2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
      *
      * Sets the settings for the current instance.
      * This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
@@ -6947,7 +6962,7 @@ var settings;
     settings.setSettings = setSettings;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
+     * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
      *
      * Registers a handler for when the user attempts to save the settings. This handler should be used
      * to create or update the underlying resource powering the content.
@@ -6962,7 +6977,7 @@ var settings;
     settings.registerOnSaveHandler = registerOnSaveHandler;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
+     * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
      *
      * Registers a handler for user attempts to remove content. This handler should be used
      * to remove the underlying resource powering the content.
@@ -6997,7 +7012,7 @@ var __rest = (undefined && undefined.__rest) || function (s, e) {
 
 /**
  * @deprecated
- * As of 2.0.0-beta.1, please use {@link dialog} namespace instead.
+ * As of 2.0.0, please use {@link dialog} namespace instead.
  *
  * Namespace to interact with the task module-specific part of the SDK.
  * This object is usable only on the content frame.
@@ -7007,7 +7022,7 @@ var tasks;
 (function (tasks) {
     /**
      * @deprecated
-     * As of 2.0.0-beta.4, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
+     * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
      * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
      *
      * Allows an app to open the task module.
@@ -7035,7 +7050,7 @@ var tasks;
     tasks.startTask = startTask;
     /**
      * @deprecated
-     * As of 2.0.0-beta.4, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
+     * As of 2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
      *
      * Update height/width task info properties.
      *
@@ -7053,7 +7068,7 @@ var tasks;
     tasks.updateTask = updateTask;
     /**
      * @deprecated
-     * As of 2.0.0-beta.1, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
+     * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
      *
      * Submit the task module.
      *
@@ -7300,7 +7315,7 @@ var files;
      * Hide from docs
      * ------
      *
-     * Open a cloud storage file in teams
+     * Open a cloud storage file in Teams
      *
      * @param file - cloud storage file that should be opened
      * @param providerCode - Code of the cloud storage folder provider
@@ -7394,97 +7409,6 @@ var files;
     files_1.openDownloadFolder = openDownloadFolder;
 })(files || (files = {}));
 
-;// CONCATENATED MODULE: ./src/private/legacy.ts
-
-
-
-
-
-
-
-/**
- * @internal
- */
-var legacy;
-(function (legacy) {
-    var fullTrust;
-    (function (fullTrust) {
-        var joinedTeams;
-        (function (joinedTeams) {
-            /**
-             * @hidden
-             * Hide from docs
-             * ------
-             * Allows an app to retrieve information of all user joined teams
-             *
-             * @param teamInstanceParameters - OPTIONAL Flags that specify whether to scope call to favorite teams
-             * @returns Promise resolved containing information about the user joined teams or rejected with error
-             */
-            function getUserJoinedTeams(teamInstanceParameters) {
-                return new Promise(function (resolve) {
-                    ensureInitialized();
-                    if (!isSupported()) {
-                        throw errorNotSupportedOnPlatform;
-                    }
-                    if ((GlobalVars.hostClientType === HostClientType.android ||
-                        GlobalVars.hostClientType === HostClientType.teamsRoomsAndroid ||
-                        GlobalVars.hostClientType === HostClientType.teamsPhones ||
-                        GlobalVars.hostClientType === HostClientType.teamsDisplays) &&
-                        !isCurrentSDKVersionAtLeast(getUserJoinedTeamsSupportedAndroidClientVersion)) {
-                        var oldPlatformError = { errorCode: ErrorCode.OLD_PLATFORM };
-                        throw new Error(JSON.stringify(oldPlatformError));
-                    }
-                    resolve(sendAndUnwrap('getUserJoinedTeams', teamInstanceParameters));
-                });
-            }
-            joinedTeams.getUserJoinedTeams = getUserJoinedTeams;
-            function isSupported() {
-                return runtime.supports.teams
-                    ? runtime.supports.teams.fullTrust
-                        ? runtime.supports.teams.fullTrust.joinedTeams
-                            ? true
-                            : false
-                        : false
-                    : false;
-            }
-            joinedTeams.isSupported = isSupported;
-        })(joinedTeams = fullTrust.joinedTeams || (fullTrust.joinedTeams = {}));
-        /**
-         * @hidden
-         * Hide from docs
-         * ------
-         * Allows an app to get the configuration setting value
-         *
-         * @param key - The key for the config setting
-         * @returns Promise resolved containing the value for the provided config setting or rejected with error
-         */
-        function getConfigSetting(key) {
-            return new Promise(function (resolve) {
-                ensureInitialized();
-                if (!isSupported()) {
-                    throw errorNotSupportedOnPlatform;
-                }
-                resolve(sendAndUnwrap('getConfigSetting', key));
-            });
-        }
-        fullTrust.getConfigSetting = getConfigSetting;
-        /**
-         * Checks if teams.fullTrust capability is supported currently
-         */
-        function isSupported() {
-            return runtime.supports.teams ? (runtime.supports.teams.fullTrust ? true : false) : false;
-        }
-        fullTrust.isSupported = isSupported;
-    })(fullTrust = legacy.fullTrust || (legacy.fullTrust = {}));
-    /**
-     * Checks if teams capability is supported currently
-     */
-    function isSupported() {
-        return runtime.supports.teams ? true : false;
-    }
-    legacy.isSupported = isSupported;
-})(legacy || (legacy = {}));
-
 ;// CONCATENATED MODULE: ./src/private/meetingRoom.ts
 
 
@@ -7863,9 +7787,9 @@ var appEntity;
      * --------
      * Open the Tab Gallery and retrieve the app entity
      * @param threadId ID of the thread where the app entity will be created
-     * @param categories A list of app categories that will be displayed in the opened tab gallery
+     * @param categories A list of application categories that will be displayed in the opened tab gallery
      * @param subEntityId An object that will be made available to the application being configured
-     *                      through the Teams Context's subEntityId field.
+     *                      through the Context's subEntityId field.
      * @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
@@ -7884,6 +7808,11 @@ var appEntity;
         sendMessageToParent('appEntity.selectAppEntity', [threadId, categories, subEntityId], callback);
     }
     appEntity_1.selectAppEntity = selectAppEntity;
+    /**
+     * Checks if appEntity capability is supported by the host
+     * @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.appEntity ? true : false;
     }
@@ -7895,6 +7824,9 @@ var appEntity;
 
 
 
+
+
+
 /**
  * @hidden
  * Namespace to interact with the `teams` specific part of the SDK.
@@ -7955,10 +7887,107 @@ var teams;
         sendMessageToParent('teams.refreshSiteUrl', [threadId], callback);
     }
     teams.refreshSiteUrl = refreshSiteUrl;
+    /**
+     * @hidden
+     * Checks if teams capability is supported by the host
+     *
+     * @returns true if the teams capability is enabled in runtime.supports.teams and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.teams ? true : false;
     }
     teams.isSupported = isSupported;
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     *
+     * @internal
+     */
+    var fullTrust;
+    (function (fullTrust) {
+        var joinedTeams;
+        (function (joinedTeams) {
+            /**
+             * @hidden
+             * Hide from docs
+             * ------
+             * Allows an app to retrieve information of all user joined teams
+             *
+             * @param teamInstanceParameters - Optional flags that specify whether to scope call to favorite teams
+             * @returns Promise that resolves with information about the user joined teams or rejects with an error when the operation has completed
+             */
+            function getUserJoinedTeams(teamInstanceParameters) {
+                return new Promise(function (resolve) {
+                    ensureInitialized();
+                    if (!isSupported()) {
+                        throw errorNotSupportedOnPlatform;
+                    }
+                    if ((GlobalVars.hostClientType === HostClientType.android ||
+                        GlobalVars.hostClientType === HostClientType.teamsRoomsAndroid ||
+                        GlobalVars.hostClientType === HostClientType.teamsPhones ||
+                        GlobalVars.hostClientType === HostClientType.teamsDisplays) &&
+                        !isCurrentSDKVersionAtLeast(getUserJoinedTeamsSupportedAndroidClientVersion)) {
+                        var oldPlatformError = { errorCode: ErrorCode.OLD_PLATFORM };
+                        throw new Error(JSON.stringify(oldPlatformError));
+                    }
+                    resolve(sendAndUnwrap('getUserJoinedTeams', teamInstanceParameters));
+                });
+            }
+            joinedTeams.getUserJoinedTeams = getUserJoinedTeams;
+            /**
+             * @hidden
+             * Hide from docs
+             * ------
+             * Checks if teams.fullTrust.joinedTeams capability is supported by the host
+             *
+             * @returns true if the teams.fullTrust.joinedTeams capability is enabled in
+             * runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
+             */
+            function isSupported() {
+                return runtime.supports.teams
+                    ? runtime.supports.teams.fullTrust
+                        ? runtime.supports.teams.fullTrust.joinedTeams
+                            ? true
+                            : false
+                        : false
+                    : false;
+            }
+            joinedTeams.isSupported = isSupported;
+        })(joinedTeams = fullTrust.joinedTeams || (fullTrust.joinedTeams = {}));
+        /**
+         * @hidden
+         * Hide from docs
+         * ------
+         * Allows an app to get the configuration setting value
+         *
+         * @param key - The key for the config setting
+         * @returns Promise that resolves with the value for the provided configuration setting or rejects with an error when the operation has completed
+         */
+        function getConfigSetting(key) {
+            return new Promise(function (resolve) {
+                ensureInitialized();
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
+                resolve(sendAndUnwrap('getConfigSetting', key));
+            });
+        }
+        fullTrust.getConfigSetting = getConfigSetting;
+        /**
+         * @hidden
+         * Hide from docs
+         * ------
+         * Checks if teams.fullTrust capability is supported by the host
+         * @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
+         * false if it is disabled
+         */
+        function isSupported() {
+            return runtime.supports.teams ? (runtime.supports.teams.fullTrust ? true : false) : false;
+        }
+        fullTrust.isSupported = isSupported;
+    })(fullTrust = teams.fullTrust || (teams.fullTrust = {}));
 })(teams || (teams = {}));
 
 ;// CONCATENATED MODULE: ./src/private/index.ts
@@ -7972,7 +8001,6 @@ var teams;
 
 
 
-
 
 ;// CONCATENATED MODULE: ./src/index.ts