@microsoft/teams-js 2.24.0-beta.0 → 2.24.0-beta.2

package/dist/MicrosoftTeams.js

@@ -2405,7 +2405,7 @@ var HostClientType;
     HostClientType["macos"] = "macos";
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
+     * As of TeamsJS v2.0.0, please use {@link teamsRoomsWindows} instead.
      */
     HostClientType["rigel"] = "rigel";
     /** Represents the client of host, which runs on surface hub devices. */
@@ -2528,7 +2528,7 @@ var DialogDimension;
 
 /**
  * @deprecated
- * As of 2.0.0, please use {@link DialogDimension} instead.
+ * As of TeamsJS v2.0.0, please use {@link DialogDimension} instead.
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 var TaskModuleDimension = DialogDimension;
@@ -3395,7 +3395,7 @@ const _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-const version = "2.24.0-beta.0";
+const version = "2.24.0-beta.2";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3662,6 +3662,185 @@ function validateOrigin(messageOrigin) {
     });
 }
 
+;// CONCATENATED MODULE: ./src/private/messageChannels.ts
+var messageChannels_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+
+
+
+
+
+/**
+ * @hidden
+ * Namespace to request message ports from the host application.
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+var messageChannels;
+(function (messageChannels) {
+    let telemetry;
+    (function (telemetry) {
+        let telemetryPort;
+        const messageChannelsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
+        const logger = getLogger('messageChannels.telemetry');
+        /**
+         * @hidden
+         * @beta
+         *
+         * Fetches a MessagePort to batch telemetry through the host's telemetry worker.
+         * The port is cached once received, so subsequent calls return the same port.
+         * @returns MessagePort.
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed,
+         * if the host does not support the feature, or if the port request is rejected.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function getTelemetryPort() {
+            return messageChannels_awaiter(this, void 0, void 0, function* () {
+                // If the port has already been initialized, return it.
+                if (telemetryPort) {
+                    logger('Returning telemetry port from cache');
+                    return telemetryPort;
+                }
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
+                // Send request for telemetry port, will throw if the request is rejected
+                telemetryPort = yield requestPortFromParentWithVersion(getApiVersionTag(messageChannelsTelemetryVersionNumber, "messageChannels.telemetry.getTelemetryPort" /* ApiName.MessageChannels_Telemetry_GetTelemetryPort */), "messageChannels.telemetry.getTelemetryPort" /* ApiName.MessageChannels_Telemetry_GetTelemetryPort */);
+                return telemetryPort;
+            });
+        }
+        telemetry.getTelemetryPort = getTelemetryPort;
+        /**
+         * @hidden
+         *
+         * @beta
+         *
+         * Checks if the messageChannels.telemetry capability is supported by the host
+         * @returns boolean to represent whether the messageChannels.telemetry capability is supported
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function isSupported() {
+            var _a;
+            return ensureInitialized(runtime) && ((_a = runtime.supports.messageChannels) === null || _a === void 0 ? void 0 : _a.telemetry) ? true : false;
+        }
+        telemetry.isSupported = isSupported;
+        /**
+         * @hidden
+         * Undocumented function used to clear state between unit tests
+         *
+         * @beta
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function _clearTelemetryPort() {
+            telemetryPort = undefined;
+        }
+        telemetry._clearTelemetryPort = _clearTelemetryPort;
+    })(telemetry = messageChannels.telemetry || (messageChannels.telemetry = {}));
+    let dataLayer;
+    (function (dataLayer) {
+        let dataLayerPort;
+        const messageChannelsDataLayerVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
+        const logger = getLogger('messageChannels.dataLayer');
+        /**
+         * @hidden
+         * @beta
+         *
+         * Fetches a MessagePort to allow access to the host's data layer worker.
+         * The port is cached once received, so subsequent calls return the same port.
+         * @returns MessagePort.
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed,
+         * if the host does not support the feature, or if the port request is rejected.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function getDataLayerPort() {
+            return messageChannels_awaiter(this, void 0, void 0, function* () {
+                // If the port has already been initialized, return it.
+                if (dataLayerPort) {
+                    logger('Returning dataLayer port from cache');
+                    return dataLayerPort;
+                }
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
+                // Send request for telemetry port, will throw if the request is rejected
+                dataLayerPort = yield requestPortFromParentWithVersion(getApiVersionTag(messageChannelsDataLayerVersionNumber, "messageChannels.dataLayer.getDataLayerPort" /* ApiName.MessageChannels_DataLayer_GetDataLayerPort */), "messageChannels.dataLayer.getDataLayerPort" /* ApiName.MessageChannels_DataLayer_GetDataLayerPort */);
+                return dataLayerPort;
+            });
+        }
+        dataLayer.getDataLayerPort = getDataLayerPort;
+        /**
+         * @hidden
+         *
+         * @beta
+         *
+         * Checks if the messageChannels.dataLayer capability is supported by the host
+         * @returns boolean to represent whether the messageChannels.dataLayer capability is supported
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function isSupported() {
+            var _a;
+            return ensureInitialized(runtime) && ((_a = runtime.supports.messageChannels) === null || _a === void 0 ? void 0 : _a.dataLayer) ? true : false;
+        }
+        dataLayer.isSupported = isSupported;
+        /**
+         * @hidden
+         * Undocumented function used to clear state between unit tests
+         *
+         * @beta
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function _clearDataLayerPort() {
+            dataLayerPort = undefined;
+        }
+        dataLayer._clearDataLayerPort = _clearDataLayerPort;
+    })(dataLayer = messageChannels.dataLayer || (messageChannels.dataLayer = {}));
+    /**
+     * @hidden
+     *
+     * @beta
+     *
+     * Checks if the messageChannels capability is supported by the host
+     * @returns boolean to represent whether the messageChannels capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function isSupported() {
+        return ensureInitialized(runtime) && runtime.supports.messageChannels ? true : false;
+    }
+    messageChannels.isSupported = isSupported;
+})(messageChannels || (messageChannels = {}));
+
 ;// CONCATENATED MODULE: ./src/public/authentication.ts
 
 
@@ -3698,7 +3877,7 @@ var authentication;
     let authParams;
     /**
      * @deprecated
-     * As of 2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
+     * As of TeamsJS v2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
      *
      * Registers handlers to be called with the result of an authentication flow triggered using {@link authentication.authenticate authentication.authenticate(authenticateParameters?: AuthenticateParameters): void}
      *
@@ -5050,10 +5229,35 @@ var app;
     }
     app.registerOnThemeChangeHandler = registerOnThemeChangeHandler;
     /**
-     * open link API.
+     * This function opens deep links to other modules in the host such as chats or channels or
+     * general-purpose links (to external websites). It should not be used for navigating to your
+     * own or other apps.
      *
-     * @param deepLink - deep link.
-     * @returns Promise that will be fulfilled when the operation has completed
+     * @remarks
+     * If you need to navigate to your own or other apps, use:
+     *
+     * - {@link pages.currentApp.navigateToDefaultPage} for navigating to the default page of your own app
+     * - {@link pages.currentApp.navigateTo} for navigating to a section of your own app
+     * - {@link pages.navigateToApp} for navigating to other apps besides your own
+     *
+     * Many areas of functionality previously provided by deep links are now handled by strongly-typed functions in capabilities.
+     * If your app is using a deep link to trigger these specific components, use the strongly-typed alternatives.
+     * For example (this list is not exhaustive):
+     * - To open an app installation dialog, use the {@link appInstallDialog} capability
+     * - To start a call, use the {@link call} capability
+     * - To open a chat, use the {@link chat} capability
+     * - To open a dialog, use the {@link dialog} capability
+     * - To create a new meeting, use the {@link calendar.composeMeeting} function
+     * - To open a Stage View, use the {@link stageView} capability
+     *
+     * In each of these capabilities, you can use the `isSupported()` function to determine if the host supports that capability.
+     * When using a deep link to trigger these components, there's no way to determine whether the host supports it.
+     *
+     * For more information on crafting deep links to the host, see [Configure deep links](https://learn.microsoft.com/microsoftteams/platform/concepts/build-and-test/deep-links)
+     *
+     * @param deepLink The host deep link or external web URL to which to navigate
+     * @returns `Promise` that will be fulfilled when the navigation has initiated. A successful `Promise` resolution
+     * does not necessarily indicate whether the target loaded successfully.
      */
     function openLink(deepLink) {
         return openLinkHelper(getApiVersionTag(appTelemetryVersionNumber, "app.openLink" /* ApiName.App_OpenLink */), deepLink);
@@ -5140,6 +5344,7 @@ function transformLegacyContextToAppContext(legacyContext) {
             subPageId: legacyContext.subEntityId,
             isFullScreen: legacyContext.isFullScreen,
             isMultiWindow: legacyContext.isMultiWindow,
+            isBackgroundLoad: legacyContext.isBackgroundLoad,
             sourceOrigin: legacyContext.sourceOrigin,
         },
         user: {
@@ -5407,13 +5612,12 @@ var pages;
     }
     pages.navigateCrossDomain = navigateCrossDomain;
     /**
-     * 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
-     * @returns a promise that will resolve if the navigation was successful
+     * Used to navigate to apps other than your own.
+     *
+     * If you are looking to navigate within your own app, use {@link pages.currentApp.navigateToDefaultPage} or {@link pages.currentApp.navigateTo}
+     *
+     * @param params Parameters for the navigation
+     * @returns a `Promise` that will resolve if the navigation was successful or reject if it was not
      */
     function navigateToApp(params) {
         return new Promise((resolve) => {
@@ -5931,15 +6135,21 @@ var pages;
         appButton.isSupported = isSupported;
     })(appButton = pages.appButton || (pages.appButton = {}));
     /**
-     * Provides functions for navigating without needing to specify your application ID.
+     * Provides functions for navigating within your own app
+     *
+     * @remarks
+     * If you are looking to navigate to a different app, use {@link pages.navigateToApp}.
      */
     let currentApp;
     (function (currentApp) {
         /**
-         * Navigate within the currently running application with page ID, and sub-page ID (for navigating to
-         * specific content within the page).
-         * @param params - Parameters for the navigation
-         * @returns a promise that will resolve if the navigation was successful
+         * Navigate within the currently running app
+         *
+         * @remarks
+         * If you are looking to navigate to a different app, use {@link pages.navigateToApp}.
+         *
+         * @param params Parameters for the navigation
+         * @returns `Promise` that will resolve if the navigation was successful and reject if not
          */
         function navigateTo(params) {
             return new Promise((resolve) => {
@@ -5952,8 +6162,10 @@ var pages;
         }
         currentApp.navigateTo = navigateTo;
         /**
-         * Navigate to the currently running application's first static page defined in the application
+         * Navigate to the currently running app's first static page defined in the application
          * manifest.
+         *
+         * @returns `Promise` that will resolve if the navigation was successful and reject if not
          */
         function navigateToDefaultPage() {
             return new Promise((resolve) => {
@@ -8705,185 +8917,6 @@ var meetingRoom;
     meetingRoom.isSupported = isSupported;
 })(meetingRoom || (meetingRoom = {}));
 
-;// CONCATENATED MODULE: ./src/private/messageChannels.ts
-var messageChannels_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-
-
-
-
-
-/**
- * @hidden
- * Namespace to request message ports from the host application.
- *
- * @beta
- *
- * @internal
- * Limited to Microsoft-internal use
- */
-var messageChannels;
-(function (messageChannels) {
-    let telemetry;
-    (function (telemetry) {
-        let telemetryPort;
-        const messageChannelsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
-        const logger = getLogger('messageChannels.telemetry');
-        /**
-         * @hidden
-         * @beta
-         *
-         * Fetches a MessagePort to batch telemetry through the host's telemetry worker.
-         * The port is cached once received, so subsequent calls return the same port.
-         * @returns MessagePort.
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed,
-         * if the host does not support the feature, or if the port request is rejected.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function getTelemetryPort() {
-            return messageChannels_awaiter(this, void 0, void 0, function* () {
-                // If the port has already been initialized, return it.
-                if (telemetryPort) {
-                    logger('Returning telemetry port from cache');
-                    return telemetryPort;
-                }
-                if (!isSupported()) {
-                    throw errorNotSupportedOnPlatform;
-                }
-                // Send request for telemetry port, will throw if the request is rejected
-                telemetryPort = yield requestPortFromParentWithVersion(getApiVersionTag(messageChannelsTelemetryVersionNumber, "messageChannels.telemetry.getTelemetryPort" /* ApiName.MessageChannels_Telemetry_GetTelemetryPort */), "messageChannels.telemetry.getTelemetryPort" /* ApiName.MessageChannels_Telemetry_GetTelemetryPort */);
-                return telemetryPort;
-            });
-        }
-        telemetry.getTelemetryPort = getTelemetryPort;
-        /**
-         * @hidden
-         *
-         * @beta
-         *
-         * Checks if the messageChannels.telemetry capability is supported by the host
-         * @returns boolean to represent whether the messageChannels.telemetry capability is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function isSupported() {
-            var _a;
-            return ensureInitialized(runtime) && ((_a = runtime.supports.messageChannels) === null || _a === void 0 ? void 0 : _a.telemetry) ? true : false;
-        }
-        telemetry.isSupported = isSupported;
-        /**
-         * @hidden
-         * Undocumented function used to clear state between unit tests
-         *
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function _clearTelemetryPort() {
-            telemetryPort = undefined;
-        }
-        telemetry._clearTelemetryPort = _clearTelemetryPort;
-    })(telemetry = messageChannels.telemetry || (messageChannels.telemetry = {}));
-    let dataLayer;
-    (function (dataLayer) {
-        let dataLayerPort;
-        const messageChannelsDataLayerVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
-        const logger = getLogger('messageChannels.dataLayer');
-        /**
-         * @hidden
-         * @beta
-         *
-         * Fetches a MessagePort to allow access to the host's data layer worker.
-         * The port is cached once received, so subsequent calls return the same port.
-         * @returns MessagePort.
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed,
-         * if the host does not support the feature, or if the port request is rejected.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function getDataLayerPort() {
-            return messageChannels_awaiter(this, void 0, void 0, function* () {
-                // If the port has already been initialized, return it.
-                if (dataLayerPort) {
-                    logger('Returning dataLayer port from cache');
-                    return dataLayerPort;
-                }
-                if (!isSupported()) {
-                    throw errorNotSupportedOnPlatform;
-                }
-                // Send request for telemetry port, will throw if the request is rejected
-                dataLayerPort = yield requestPortFromParentWithVersion(getApiVersionTag(messageChannelsDataLayerVersionNumber, "messageChannels.dataLayer.getDataLayerPort" /* ApiName.MessageChannels_DataLayer_GetDataLayerPort */), "messageChannels.dataLayer.getDataLayerPort" /* ApiName.MessageChannels_DataLayer_GetDataLayerPort */);
-                return dataLayerPort;
-            });
-        }
-        dataLayer.getDataLayerPort = getDataLayerPort;
-        /**
-         * @hidden
-         *
-         * @beta
-         *
-         * Checks if the messageChannels.dataLayer capability is supported by the host
-         * @returns boolean to represent whether the messageChannels.dataLayer capability is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function isSupported() {
-            var _a;
-            return ensureInitialized(runtime) && ((_a = runtime.supports.messageChannels) === null || _a === void 0 ? void 0 : _a.dataLayer) ? true : false;
-        }
-        dataLayer.isSupported = isSupported;
-        /**
-         * @hidden
-         * Undocumented function used to clear state between unit tests
-         *
-         * @beta
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function _clearDataLayerPort() {
-            dataLayerPort = undefined;
-        }
-        dataLayer._clearDataLayerPort = _clearDataLayerPort;
-    })(dataLayer = messageChannels.dataLayer || (messageChannels.dataLayer = {}));
-    /**
-     * @hidden
-     *
-     * @beta
-     *
-     * Checks if the messageChannels capability is supported by the host
-     * @returns boolean to represent whether the messageChannels capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function isSupported() {
-        return ensureInitialized(runtime) && runtime.supports.messageChannels ? true : false;
-    }
-    messageChannels.isSupported = isSupported;
-})(messageChannels || (messageChannels = {}));
-
 ;// CONCATENATED MODULE: ./src/private/notifications.ts
 
 
@@ -14216,7 +14249,7 @@ var call;
 
 /**
  * @deprecated
- * As of 2.0.0, please use {@link app} namespace instead.
+ * As of TeamsJS v2.0.0, please use {@link app} namespace instead.
  *
  * v1 APIs telemetry file: All of APIs in this capability file should send out API version v1 ONLY
  */
@@ -14225,25 +14258,25 @@ var appInitialization;
 (function (appInitialization) {
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.Messages} instead.
+     * As of TeamsJS v2.0.0, please use {@link app.Messages} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.Messages = app.Messages;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.FailedReason} instead.
+     * As of TeamsJS v2.0.0, please use {@link app.FailedReason} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.FailedReason = app.FailedReason;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.ExpectedFailureReason} instead.
+     * As of TeamsJS v2.0.0, please use {@link app.ExpectedFailureReason} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.ExpectedFailureReason = app.ExpectedFailureReason;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
+     * As of TeamsJS v2.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.
      */
@@ -14253,7 +14286,7 @@ var appInitialization;
     appInitialization.notifyAppLoaded = notifyAppLoaded;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
+     * As of TeamsJS v2.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.
      */
@@ -14263,7 +14296,7 @@ var appInitialization;
     appInitialization.notifySuccess = notifySuccess;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
+     * As of TeamsJS v2.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
@@ -14275,7 +14308,7 @@ var appInitialization;
     appInitialization.notifyFailure = notifyFailure;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
+     * As of TeamsJS v2.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
@@ -14459,7 +14492,7 @@ var thirdPartyCloudStorage;
 const publicAPIsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
 /**
  * @deprecated
- * As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
+ * As of TeamsJS v2.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.
@@ -14476,7 +14509,7 @@ function initialize(callback, validMessageOrigins) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
  *
  * Enable print capability to support printing page using Ctrl+P and cmd+P
  */
@@ -14485,7 +14518,7 @@ function enablePrintCapability() {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
  *
  * Default print handler
  */
@@ -14494,7 +14527,7 @@ function print() {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
+ * As of TeamsJS v2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
  *
  * Retrieves the current context the frame is running in.
  *
@@ -14512,7 +14545,7 @@ function getContext(callback) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void} instead.
  *
  * Registers a handler for theme changes.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -14524,7 +14557,7 @@ function publicAPIs_registerOnThemeChangeHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): 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.
@@ -14536,7 +14569,7 @@ function registerFullScreenHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: callbackFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: callbackFunctionType): 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.
@@ -14548,7 +14581,7 @@ function registerAppButtonClickHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: callbackFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: callbackFunctionType): 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.
@@ -14560,7 +14593,7 @@ function registerAppButtonHoverEnterHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: callbackFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: callbackFunctionType): 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.
@@ -14572,7 +14605,7 @@ function registerAppButtonHoverLeaveHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): 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
@@ -14586,7 +14619,7 @@ function registerBackButtonHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
+ * As of TeamsJS v2.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.
@@ -14598,7 +14631,7 @@ function registerOnLoadHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: callbackFunctionType) => boolean): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: callbackFunctionType) => boolean): void} instead.
  *
  * @hidden
  * Registers a handler to be called before the page is unloaded.
@@ -14611,7 +14644,7 @@ function registerBeforeUnloadHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
+ * As of TeamsJS v2.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.
@@ -14623,7 +14656,7 @@ function registerFocusEnterHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: callbackFunctionType): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: callbackFunctionType): void} instead.
  *
  * Registers a handler for when the user reconfigurated tab.
  *
@@ -14634,7 +14667,7 @@ function registerChangeSettingsHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
+ * As of TeamsJS v2.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.
@@ -14650,7 +14683,7 @@ function getTabInstances(callback, tabInstanceParameters) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
+ * As of TeamsJS v2.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.
  *
@@ -14665,7 +14698,7 @@ function getMruTabInstances(callback, tabInstanceParameters) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
+ * As of TeamsJS v2.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.
  *
@@ -14680,11 +14713,16 @@ function shareDeepLink(deepLinkParameters) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link app.openLink app.openLink(deepLink: string): Promise\<void\>} instead.
+ * This function was previously used for opening various types of links. As of TeamsJS v2.0.0, it has been replaced with multiple different
+ * functions depending on the type of link:
  *
- * Execute deep link API.
+ * - Use {@link pages.currentApp.navigateToDefaultPage} to navigate to the default page of your own app
+ * - Use {@link pages.currentApp.navigateTo} to navigate to a section of your own app
+ * - Use {@link pages.navigateToApp} to navigate to other apps besides your own
+ * - Use {@link app.openLink} for opening deep links to other parts of the host (e.g., to chats or channels) or
+ * general-purpose links (e.g., to external websites).
  *
- * @param deepLink - deep link.
+ * @param deepLink deep link.
  */
 function executeDeepLink(deepLink, onComplete) {
     ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
@@ -14699,7 +14737,7 @@ function executeDeepLink(deepLink, onComplete) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
  *
  * Set the current Frame Context
  *
@@ -14710,7 +14748,7 @@ function setFrameContext(frameContext) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[],): void} instead.
+ * As of TeamsJS v2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[],): void} instead.
  *
  * Initialize with FrameContext
  *
@@ -14737,7 +14775,7 @@ function initializeWithFrameContext(frameContext, callback, validMessageOrigins)
 const navigationTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
+ * As of TeamsJS v2.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.
  *
@@ -14748,7 +14786,7 @@ function returnFocus(navigateForward) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
+ * As of TeamsJS v2.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.
  *
@@ -14768,7 +14806,7 @@ function navigateToTab(tabInstance, onComplete) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
+ * As of TeamsJS v2.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
@@ -14792,7 +14830,7 @@ function navigateCrossDomain(url, onComplete) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
+ * As of TeamsJS v2.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.
@@ -14824,7 +14862,7 @@ function navigateBack(onComplete) {
 const settingsTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.config} namespace instead.
+ * As of TeamsJS v2.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.
@@ -14833,7 +14871,7 @@ var settings;
 (function (settings) {
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
+     * As of TeamsJS v2.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.
@@ -14846,7 +14884,7 @@ var settings;
     settings.setValidityState = setValidityState;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
+     * As of TeamsJS v2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
      *
      * Gets the settings for the current instance.
      *
@@ -14861,7 +14899,7 @@ var settings;
     settings.getSettings = getSettings;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
+     * As of TeamsJS v2.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.
@@ -14882,7 +14920,7 @@ var settings;
     settings.setSettings = setSettings;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void} instead.
+     * As of TeamsJS v2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): 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.
@@ -14897,7 +14935,7 @@ var settings;
     settings.registerOnSaveHandler = registerOnSaveHandler;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead.
+     * As of TeamsJS v2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead.
      *
      * Registers a handler for user attempts to remove content. This handler should be used
      * to remove the underlying resource powering the content.
@@ -14938,7 +14976,7 @@ var tasks_rest = (undefined && undefined.__rest) || function (s, e) {
 const tasksTelemetryVersionNumber = "v1" /* ApiVersionNumber.V_1 */;
 /**
  * @deprecated
- * As of 2.0.0, please use {@link dialog} namespace instead.
+ * As of TeamsJS v2.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.
@@ -14985,7 +15023,7 @@ var tasks;
     tasks.startTask = startTask;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
+     * As of TeamsJS v2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
      *
      * Update height/width task info properties.
      *