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

package/dist/MicrosoftTeams.js

@@ -395,7 +395,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = '2.0.0-beta.2-dev.3';
+var version = '2.0.0-beta.2';
 /**
  * @hidden
  * The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -803,8 +803,7 @@ function ensureInitialized() {
             }
         }
         if (!found) {
-            throw new Error("This call is only allowed in following contexts: " + JSON.stringify(expectedFrameContexts) + ". " +
-                ("Current context: \"" + GlobalVars.frameContext + "\"."));
+            throw new Error("This call is not allowed in the '" + GlobalVars.frameContext + "' context");
         }
     }
 }
@@ -1197,7 +1196,8 @@ var HostClientType;
     HostClientType["android"] = "android";
     HostClientType["ios"] = "ios";
     /**
-     * @deprecated Use teamsRoomsWindows instead.
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link teamsRoomsWindows} instead.
      */
     HostClientType["rigel"] = "rigel";
     HostClientType["surfaceHub"] = "surfaceHub";
@@ -1256,7 +1256,8 @@ var DialogDimension;
     DialogDimension["Small"] = "small";
 })(DialogDimension || (DialogDimension = {}));
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link DialogDimension} instead.
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 var TaskModuleDimension = DialogDimension;
@@ -1294,7 +1295,8 @@ var authentication;
     authentication.initialize = initialize;
     var authParams;
     /**
-     * @deprecated with Teams JS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1.
      *
      * Registers the authentication Communication.handlers
      *
@@ -4619,27 +4621,32 @@ var call;
 ;// CONCATENATED MODULE: ./src/public/appInitialization.ts
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link app} namespace instead.
  */
 var appInitialization;
 (function (appInitialization) {
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link app.Messages} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.Messages = app_app.Messages;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link app.FailedReason} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.FailedReason = app_app.FailedReason;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link app.ExpectedFailureReason} instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     appInitialization.ExpectedFailureReason = app_app.ExpectedFailureReason;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, 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.
      */
     function notifyAppLoaded() {
@@ -4647,7 +4654,8 @@ var appInitialization;
     }
     appInitialization.notifyAppLoaded = notifyAppLoaded;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
      * Notifies the frame that app initialization is successful and is ready for user interaction.
      */
     function notifySuccess() {
@@ -4655,7 +4663,8 @@ var appInitialization;
     }
     appInitialization.notifySuccess = notifySuccess;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, 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.
      */
     function notifyFailure(appInitializationFailedRequest) {
@@ -4663,7 +4672,8 @@ var appInitialization;
     }
     appInitialization.notifyFailure = notifyFailure;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
      * Notifies the frame that app initialized with some expected errors.
      */
     function notifyExpectedFailure(expectedFailureRequest) {
@@ -4679,7 +4689,8 @@ var appInitialization;
 
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4695,7 +4706,8 @@ function initialize(callback, validMessageOrigins) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
  *
  * @hidden
  * Hide from docs.
@@ -4709,7 +4721,8 @@ function _initialize(hostWindow) {
     app._initialize(hostWindow);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link app._uninitialize app._uninitialize(): void} instead.
  *
  * @hidden
  * Hide from docs.
@@ -4722,7 +4735,8 @@ function _uninitialize() {
     app._uninitialize();
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
  *
  * Enable print capability to support printing page using Ctrl+P and cmd+P
  */
@@ -4730,7 +4744,8 @@ function enablePrintCapability() {
     teamsCore.enablePrintCapability();
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link teamsCore.print teamsCore.print(): void} instead.
  *
  * Default print handler
  */
@@ -4738,7 +4753,8 @@ function print() {
     teamsCore.print();
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
  *
  * Retrieves the current context the frame is running in.
  *
@@ -4753,7 +4769,8 @@ function getContext(callback) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4764,7 +4781,8 @@ function registerOnThemeChangeHandler(handler) {
     app_app.registerOnThemeChangeHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4775,7 +4793,8 @@ function registerFullScreenHandler(handler) {
     pages.registerFullScreenHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4786,7 +4805,8 @@ function registerAppButtonClickHandler(handler) {
     pages.appButton.onClick(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4797,7 +4817,8 @@ function registerAppButtonHoverEnterHandler(handler) {
     pages.appButton.onHoverEnter(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4808,7 +4829,8 @@ function registerAppButtonHoverLeaveHandler(handler) {
     pages.appButton.onHoverLeave(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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
@@ -4821,7 +4843,8 @@ function registerBackButtonHandler(handler) {
     pages.backStack.registerBackButtonHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4832,7 +4855,8 @@ function registerOnLoadHandler(handler) {
     teamsCore.registerOnLoadHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4844,7 +4868,8 @@ function registerBeforeUnloadHandler(handler) {
     teamsCore.registerBeforeUnloadHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link teamsCore.registerFocusEnterHandler teamsCore.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.
@@ -4855,7 +4880,8 @@ function registerFocusEnterHandler(handler) {
     teamsCore.registerFocusEnterHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
  *
  * Registers a handler for when the user reconfigurated tab.
  *
@@ -4865,7 +4891,8 @@ function registerEnterSettingsHandler(handler) {
     pages.config.registerChangeConfigHandler(handler);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -4880,7 +4907,8 @@ function getTabInstances(callback, tabInstanceParameters) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
  *
@@ -4894,7 +4922,8 @@ function getMruTabInstances(callback, tabInstanceParameters) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link core.shareDeepLink core.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
  *
  * Shares a deep link that a user can use to navigate back to a specific state in this page.
  *
@@ -4904,7 +4933,8 @@ function shareDeepLink(deepLinkParameters) {
     core.shareDeepLink(deepLinkParameters);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link core.executeDeepLink core.executeDeepLink(deepLink: string): Promise\<void\>} instead.
  *
  * Execute deep link API.
  *
@@ -4925,7 +4955,8 @@ function executeDeepLink(deepLink, onComplete) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
  *
  * Set the current Frame Context
  *
@@ -4935,7 +4966,8 @@ function setFrameContext(frameContext) {
     pages.setCurrentFrame(frameContext);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
  *
  * Initilize with FrameContext
  *
@@ -5030,7 +5062,8 @@ function transformAppContextToLegacyContext(appContext) {
  * Navigation specific part of the SDK.
  */
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
  *
@@ -5040,7 +5073,8 @@ function returnFocus(navigateForward) {
     pages.returnFocus(navigateForward);
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
  *
  * Navigates the Microsoft Teams app to the specified tab instance.
  *
@@ -5062,7 +5096,8 @@ function navigateToTab(tabInstance, onComplete) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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
@@ -5088,7 +5123,8 @@ function navigateCrossDomain(url, onComplete) {
     });
 }
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -5115,7 +5151,8 @@ function navigateBack(onComplete) {
 
 
 /**
- * @deprecated with Teams JS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -5123,7 +5160,8 @@ function navigateBack(onComplete) {
 var settings;
 (function (settings) {
     /**
-     * @deprecated with Teams JS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, 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.
@@ -5135,7 +5173,8 @@ var settings;
     }
     settings.setValidityState = setValidityState;
     /**
-     * @deprecated with Teams JS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
      *
      * Gets the settings for the current instance.
      *
@@ -5149,7 +5188,8 @@ var settings;
     }
     settings.getSettings = getSettings;
     /**
-     * @deprecated with Teams JS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, 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.
@@ -5172,7 +5212,8 @@ var settings;
     }
     settings.setSettings = setSettings;
     /**
-     * @deprecated with Teams JS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, 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.
@@ -5186,7 +5227,8 @@ var settings;
     }
     settings.registerOnSaveHandler = registerOnSaveHandler;
     /**
-     * @deprecated with Teams JS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, 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.
@@ -5205,7 +5247,8 @@ var settings;
 
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1, 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.
@@ -5214,7 +5257,8 @@ var settings;
 var tasks;
 (function (tasks) {
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link dialog.open dialog.open(dialogInfo: DialogInfo, submitHandler?: (err: string, result: string) => void): IAppWindow} instead.
      *
      * Allows an app to open the task module.
      *
@@ -5226,7 +5270,8 @@ var tasks;
     }
     tasks.startTask = startTask;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link dialog.resize dialog.resize(dialogInfo: DialogInfo): void} instead.
      *
      * Update height/width task info properties.
      *
@@ -5237,7 +5282,8 @@ var tasks;
     }
     tasks.updateTask = updateTask;
     /**
-     * @deprecated with TeamsJS v2 upgrades
+     * @deprecated
+     * As of 2.0.0-beta.1, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
      *
      * Submit the task module.
      *
@@ -5301,23 +5347,28 @@ var tasks;
 
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1.
  */
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1.
  */
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1.
  */
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1.
  */
 
 /**
- * @deprecated with TeamsJS v2 upgrades
+ * @deprecated
+ * As of 2.0.0-beta.1.
  */