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

package/dist/MicrosoftTeams.js

@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6";
+var version = "2.0.0-beta.6-dev.22";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -3027,18 +3027,49 @@ var app_app;
         Failure: 'appInitialization.failure',
         ExpectedFailure: 'appInitialization.expectedFailure',
     };
+    /**
+     * Describes errors that caused app initialization to fail
+     */
     var FailedReason;
     (function (FailedReason) {
+        /**
+         * Authentication failed
+         */
         FailedReason["AuthFailed"] = "AuthFailed";
+        /**
+         * The application timed out
+         */
         FailedReason["Timeout"] = "Timeout";
+        /**
+         * The app failed for a different reason
+         */
         FailedReason["Other"] = "Other";
     })(FailedReason = app.FailedReason || (app.FailedReason = {}));
+    /**
+     * Describes expected errors that occurred during an otherwise successful
+     * app initialization
+     */
     var ExpectedFailureReason;
     (function (ExpectedFailureReason) {
+        /**
+         * There was a permission error
+         */
         ExpectedFailureReason["PermissionError"] = "PermissionError";
+        /**
+         * The item was not found
+         */
         ExpectedFailureReason["NotFound"] = "NotFound";
+        /**
+         * The network is currently throttled
+         */
         ExpectedFailureReason["Throttling"] = "Throttling";
+        /**
+         * The application is currently offline
+         */
         ExpectedFailureReason["Offline"] = "Offline";
+        /**
+         * The app failed for a different reason
+         */
         ExpectedFailureReason["Other"] = "Other";
     })(ExpectedFailureReason = app.ExpectedFailureReason || (app.ExpectedFailureReason = {}));
     /**
@@ -3050,7 +3081,7 @@ var app_app;
     }
     app.isInitialized = isInitialized;
     /**
-     * Gets the Frame Context that the App is running in. {@see FrameContexts} for the list of possible values.
+     * Gets the Frame Context that the App is running in. See {@link FrameContexts} for the list of possible values.
      * @returns the Frame Context.
      */
     function getFrameContext() {
@@ -3198,7 +3229,7 @@ var app_app;
     /**
      * Retrieves the current context the frame is running in.
      *
-     * @returns Promise that will resolve with the {@link Context} object.
+     * @returns Promise that will resolve with the {@link app.Context} object.
      */
     function getContext() {
         return new Promise(function (resolve) {
@@ -3225,6 +3256,9 @@ var app_app;
     app.notifySuccess = notifySuccess;
     /**
      * 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
+     * during initialization as well as an optional message.
      */
     function notifyFailure(appInitializationFailedRequest) {
         ensureInitialized();
@@ -3236,6 +3270,8 @@ var app_app;
     app.notifyFailure = notifyFailure;
     /**
      * Notifies the frame that app initialized with some expected errors.
+     *
+     * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
      */
     function notifyExpectedFailure(expectedFailureRequest) {
         ensureInitialized();
@@ -3377,7 +3413,7 @@ function transformLegacyContextToAppContext(legacyContext) {
 
 
 /**
- * Navigation specific part of the SDK.
+ * Navigation-specific part of the SDK.
  *
  * @beta
  */
@@ -3398,6 +3434,7 @@ var pages;
     pages.returnFocus = returnFocus;
     /**
      * @hidden
+     *
      * Registers a handler when focus needs to be passed from teams to the place of choice on app.
      *
      * @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
@@ -3412,6 +3449,12 @@ var pages;
         registerHandler('focusEnter', handler);
     }
     pages.registerFocusEnterHandler = registerFocusEnterHandler;
+    /**
+     * Sets/Updates the current frame with new information
+     *
+     * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
+     * user clicks 'Go To Website'
+     */
     function setCurrentFrame(frameInfo) {
         ensureInitialized(FrameContexts.content);
         if (!isSupported()) {
@@ -3420,6 +3463,15 @@ var pages;
         sendMessageToParent('setFrameContext', [frameInfo]);
     }
     pages.setCurrentFrame = setCurrentFrame;
+    /**
+     * Initializes the library with context information for the frame
+     *
+     * @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 validMessageOrigins - An optional list of cross-frame message origins. They must have
+     * https: protocol otherwise they will be ignored. Example: https:www.example.com
+     */
     function initializeWithFrameContext(frameInfo, callback, validMessageOrigins) {
         app_app.initialize(validMessageOrigins).then(function () { return callback && callback(); });
         setCurrentFrame(frameInfo);
@@ -3514,7 +3566,9 @@ var pages;
     }
     pages.registerFullScreenHandler = registerFullScreenHandler;
     /**
-     * Checks if page capability is supported currently
+     * Checks if the current application host supports the pages capability
+     * @returns true if the pages capability is enabled in runtime.supports.pages and
+     * false if it is disabled
      */
     function isSupported() {
         return runtime.supports.pages ? true : false;
@@ -3545,7 +3599,7 @@ var pages;
          * 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.
-         * @returns Promise that resolves with the {@link TabInformation}.
+         * @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) {
             return new Promise(function (resolve) {
@@ -3559,8 +3613,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
-         * @returns Promise that resolves with the {@link TabInformation}.
+         * @param tabInstanceParameters OPTIONAL Ignored, 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) {
             return new Promise(function (resolve) {
@@ -3573,7 +3627,9 @@ var pages;
         }
         tabs.getMruTabInstances = getMruTabInstances;
         /**
-         * Checks if pages.tabs capability is supported currently
+         * Checks if the current application host supports the pages.tab capability
+         * @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
+         * false if it is disabled
          */
         function isSupported() {
             return runtime.supports.pages ? (runtime.supports.pages.tabs ? true : false) : false;
@@ -3588,6 +3644,13 @@ var pages;
     (function (config) {
         var saveHandler;
         var removeHandler;
+        /**
+         * @hidden
+         * Hide from docs because this function is only used during initialization
+         * ------------------
+         * Adds register handlers for settings.save and settings.remove upon initialization. Function is called in {@link app.initializeHelper}
+         * @internal
+         */
         function initialize() {
             registerHandler('settings.save', handleSave, false);
             registerHandler('settings.remove', handleRemove, false);
@@ -3665,7 +3728,7 @@ var pages;
             }
         }
         /**
-         * Registers a handler for when the user reconfigurated tab
+         * 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.
          */
         function registerChangeConfigHandler(handler) {
@@ -3738,7 +3801,9 @@ var pages;
             return RemoveEventImpl;
         }());
         /**
-         * Checks if pages.config capability is supported currently
+         * Checks if the current application host supports the pages.config capability
+         * @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
+         * false if it is disabled
          */
         function isSupported() {
             return runtime.supports.pages ? (runtime.supports.pages.config ? true : false) : false;
@@ -3793,13 +3858,21 @@ var pages;
             }
         }
         /**
-         * Checks if pages.backStack capability is supported currently
+         * Checks if the current application host supports the pages.backStack capability
+         * @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
+         * false if it is disabled
          */
         function isSupported() {
             return runtime.supports.pages ? (runtime.supports.pages.backStack ? true : false) : false;
         }
         backStack.isSupported = isSupported;
     })(backStack = pages.backStack || (pages.backStack = {}));
+    /**
+     * @hidden
+     * Hide from docs
+     * ------
+     * Namespace to interact with the full-trust part of the SDK. Limited to 1P apps
+     */
     var fullTrust;
     (function (fullTrust) {
         /**
@@ -3831,7 +3904,12 @@ var pages;
         }
         fullTrust.exitFullscreen = exitFullscreen;
         /**
-         * Checks if pages.fullTrust capability is supported currently
+         * @hidden
+         * Hide from docs
+         * ------
+         * Checks if the current application host supports the pages.fullTrust capability
+         * @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
+         * false if it is disabled
          */
         function isSupported() {
             return runtime.supports.pages ? (runtime.supports.pages.fullTrust ? true : false) : false;
@@ -3884,6 +3962,8 @@ var pages;
         appButton.onHoverLeave = onHoverLeave;
         /**
          * Checks if pages.appButton capability is supported currently
+         * @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
+         * false if it is disabled
          */
         function isSupported() {
             return runtime.supports.pages ? (runtime.supports.pages.appButton ? true : false) : false;
@@ -6301,6 +6381,7 @@ var appInitialization;
     /**
      * @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() {
@@ -6310,6 +6391,7 @@ var appInitialization;
     /**
      * @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() {
@@ -6319,7 +6401,10 @@ var appInitialization;
     /**
      * @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.
+     * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
+     * during initialization as well as an optional message.
      */
     function notifyFailure(appInitializationFailedRequest) {
         app_app.notifyFailure(appInitializationFailedRequest);
@@ -6328,7 +6413,9 @@ var appInitialization;
     /**
      * @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.
+     * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
      */
     function notifyExpectedFailure(expectedFailureRequest) {
         app_app.notifyExpectedFailure(expectedFailureRequest);