@microsoft/teams-js 2.0.0-beta.6-dev.21 → 2.0.0-beta.7-dev.0

package/README.md

@@ -24,7 +24,7 @@ To install the latest [2.0 preview version](https://docs.microsoft.com/en-us/jav
 
 ### Production
 
-You can access [these files on unpkg](https://res.cdn.office.net/teams-js/2.0.0-beta.5/js/MicrosoftTeams.min.js), download them, or point your package manager to them.
+You can access [these files on unpkg](https://res.cdn.office.net/teams-js/2.0.0-beta.6/js/MicrosoftTeams.min.js), download them, or point your package manager to them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the SDK inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.0.0-beta.5/js/MicrosoftTeams.min.js"
-  integrity="sha384-vZRWEk6i8zcVUxh4lQUp+rKbFHv1Thlixb5Z3DAanwntS8owtI9t2K9BmCU0WBxL"
+  src="https://res.cdn.office.net/teams-js/2.0.0-beta.6/js/MicrosoftTeams.min.js"
+  integrity="sha384-zUXDMKhIVeFW07S2xPrtvwSCnfjFTHafmXXzxnNT0ONpSv4NOmekx15PEdsHDDf4"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.0.0-beta.5/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.0.0-beta.6/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2992,7 +2992,7 @@ export namespace dialog {
 }
 
 /**
-    * Navigation specific part of the SDK.
+    * Navigation-specific part of the SDK.
     *
     * @beta
     */
@@ -3005,6 +3005,7 @@ export namespace pages {
         function returnFocus(navigateForward?: boolean): void;
         /**
             * @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.
@@ -3012,8 +3013,26 @@ export namespace pages {
             * @internal
             */
         function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
+        /**
+            * 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: FrameInfo): void;
+        /**
+            * 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: FrameInfo, callback?: () => void, validMessageOrigins?: string[]): void;
+        /**
+            * Defines the configuration of the current or desired instance
+            */
         interface InstanceConfig {
                 /**
                     * A suggested display name for the new content.
@@ -3075,7 +3094,9 @@ export namespace pages {
             */
         function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
         /**
-            * 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(): boolean;
         /**
@@ -3118,17 +3139,19 @@ export namespace 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?: TabInstanceParameters): Promise<TabInformation>;
                 /**
                     * 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?: TabInstanceParameters): Promise<TabInformation>;
                 /**
-                    * 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(): boolean;
         }
@@ -3137,6 +3160,13 @@ export namespace pages {
             * This object is usable only on the config frame.
             */
         namespace config {
+                /**
+                    * @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(): void;
                 /**
                     * Sets the validity state for the config.
@@ -3168,10 +3198,14 @@ export namespace pages {
                     */
                 function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
                 /**
-                    * 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: () => void): void;
+                /**
+                    * Describes the results of the settings.save event. Includes result, notifySuccess, and notifyFailure
+                    * to indicate the return object (result) and the status of whether the settings.save call succeeded or not and why.
+                    */
                 interface SaveEvent {
                         /**
                             * Object containing properties passed as arguments to the settings.save event.
@@ -3187,6 +3221,10 @@ export namespace pages {
                             */
                         notifyFailure(reason?: string): void;
                 }
+                /**
+                    * Describes the results of the settings.remove event. Includes notifySuccess, and notifyFailure
+                    * to indicate the status of whether the settings.save call succeeded or not and why.
+                    */
                 interface RemoveEvent {
                         /**
                             * Indicates that the underlying resource has been removed and the content can be removed.
@@ -3198,6 +3236,9 @@ export namespace pages {
                             */
                         notifyFailure(reason?: string): void;
                 }
+                /**
+                    * Parameters used in the settings.save event
+                    */
                 interface SaveParameters {
                         /**
                             * Connector's webhook Url returned as arguments to settings.save event as part of user clicking on Save
@@ -3205,7 +3246,9 @@ export namespace pages {
                         webhookUrl?: string;
                 }
                 /**
-                    * 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(): boolean;
         }
@@ -3229,10 +3272,18 @@ export namespace pages {
                     */
                 function registerBackButtonHandler(handler: () => boolean): void;
                 /**
-                    * 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(): boolean;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            * ------
+            * Namespace to interact with the full-trust part of the SDK. Limited to 1P apps
+            */
         namespace fullTrust {
                 /**
                     * @hidden
@@ -3249,7 +3300,12 @@ export namespace pages {
                     */
                 function exitFullscreen(): void;
                 /**
-                    * 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(): boolean;
         }
@@ -3277,6 +3333,8 @@ export namespace pages {
                 function onHoverLeave(handler: () => void): void;
                 /**
                     * 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(): boolean;
         }

package/dist/MicrosoftTeams.js

@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6-dev.21";
+var version = "2.0.0-beta.7-dev.0";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -3413,7 +3413,7 @@ function transformLegacyContextToAppContext(legacyContext) {
 
 
 /**
- * Navigation specific part of the SDK.
+ * Navigation-specific part of the SDK.
  *
  * @beta
  */
@@ -3434,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.
@@ -3448,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()) {
@@ -3456,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);
@@ -3550,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;
@@ -3581,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) {
@@ -3595,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) {
@@ -3609,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;
@@ -3624,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);
@@ -3701,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) {
@@ -3774,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;
@@ -3829,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) {
         /**
@@ -3867,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;
@@ -3920,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;