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

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.7-dev.6";
+var version = "2.0.0-beta.7-dev.7";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1856,7 +1856,7 @@ function uploadCustomApp(manifestBlob, onComplete) {
 /**
  * @hidden
  * Internal use only
- * Sends a custom action MessageRequest to Teams or parent window
+ * Sends a custom action MessageRequest to host or parent window
  *
  * @param actionName - Specifies name of the custom action to be sent
  * @param args - Specifies additional arguments passed to the action
@@ -2987,6 +2987,11 @@ var teamsCore;
         handlers_registerBeforeUnloadHandler(handler);
     }
     teamsCore.registerBeforeUnloadHandler = registerBeforeUnloadHandler;
+    /**
+     * Checks if teamsCore capability is supported by the host
+     * @returns true if the teamsCore capability is enabled in runtime.supports.teamsCore and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.teamsCore ? true : false;
     }
@@ -3419,8 +3424,8 @@ function transformLegacyContextToAppContext(legacyContext) {
 var pages;
 (function (pages) {
     /**
-     * Return focus to the host. Will move focus forward or backward based on where the app container falls in
-     * the F6/Tab accessiblity loop in the host.
+     * Return focus to the host. Will move focus forward or backward based on where the application container falls in
+     * the F6/tab order in the host.
      * @param navigateForward - Determines the direction to focus in host.
      */
     function returnFocus(navigateForward) {
@@ -3434,9 +3439,9 @@ var pages;
     /**
      * @hidden
      *
-     * Registers a handler when focus needs to be passed from teams to the place of choice on app.
+     * Registers a handler for specifying focus when it passes from the host to the application.
      *
-     * @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
+     * @param handler - The handler for placing focus within the application.
      *
      * @internal
      */
@@ -3467,7 +3472,7 @@ var pages;
      *
      * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
      *  user clicks 'Go To Website'
-     * @param callback - An optional user-set callback that is executed once the app has finished initialization.
+     * @param callback - An optional callback that is executed once the application has finished initialization.
      * @param validMessageOrigins - An optional list of cross-frame message origins. They must have
      * https: protocol otherwise they will be ignored. Example: https:www.example.com
      */
@@ -3494,7 +3499,7 @@ var pages;
      * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
      * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
      * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
-     * than the current one in a way that keeps the app informed of the change and allows the SDK to
+     * than the current one in a way that keeps the application informed of the change and allows the SDK to
      * continue working.
      * @param url - The URL to navigate the frame to.
      * @returns Promise that resolves when the navigation has completed.
@@ -3511,12 +3516,12 @@ var pages;
     }
     pages.navigateCrossDomain = navigateCrossDomain;
     /**
-     * Navigate to the given App ID and Page ID, with optional parameters for a WebURL (if the app cannot
-     * be navigated to, such as if it is not installed), Channel ID (for apps installed as a channel tab), and
-     * Sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
-     * a deep link with the above data, but does not require the app to build a URL or worry about different
+     * Navigate to the given application ID and page ID, with optional parameters for a WebURL (if the application
+     * cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab),
+     * and sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
+     * a deep link with the above data, but does not require the application to build a URL or worry about different
      * deep link formats for different hosts.
-     * @param params Parameters for the navigation
+     * @param params - Parameters for the navigation
      * @returns a promise that will resolve if the navigation was successful
      */
     function navigateToApp(params) {
@@ -3565,7 +3570,7 @@ var pages;
     }
     pages.registerFullScreenHandler = registerFullScreenHandler;
     /**
-     * Checks if the current application host supports the pages capability
+     * Checks if the pages capability is supported by the host
      * @returns true if the pages capability is enabled in runtime.supports.pages and
      * false if it is disabled
      */
@@ -3574,13 +3579,14 @@ var pages;
     }
     pages.isSupported = isSupported;
     /**
-     * Namespace to interact with the teams specific part of the SDK.
+     * Provides APIs for querying and navigating between contextual tabs of an application. Unlike personal tabs,
+     * contextual tabs are pages associated with a specific context, such as channel or chat.
      */
     var tabs;
     (function (tabs) {
         /**
-         * Navigates the hosted app to the specified tab instance.
-         * @param tabInstance The tab instance to navigate to.
+         * Navigates the hosted application to the specified tab instance.
+         * @param tabInstance - The destination tab instance.
          * @returns Promise that resolves when the navigation has completed.
          */
         function navigateToTab(tabInstance) {
@@ -3595,9 +3601,9 @@ var pages;
         }
         tabs.navigateToTab = navigateToTab;
         /**
-         * Allows an app to retrieve for this user tabs that are owned by this app.
-         * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
-         * @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
+         * Retrieves application tabs for the current user.
+         * If no TabInstanceParameters are passed, the application defaults to favorite teams and favorite channels.
+         * @param tabInstanceParameters - An optional set of flags that specify whether to scope call to favorite teams or channels.
          * @returns Promise that resolves with the {@link TabInformation}. Contains information for the user's tabs that are owned by this application {@link TabInstance}.
          */
         function getTabInstances(tabInstanceParameters) {
@@ -3611,8 +3617,8 @@ var pages;
         }
         tabs.getTabInstances = getTabInstances;
         /**
-         * Allows an app to retrieve the most recently used tabs for this user.
-         * @param tabInstanceParameters OPTIONAL Ignored, kept for future use.
+         * Retrieves the most recently used application tabs for the current user.
+         * @param tabInstanceParameters - An optional set of flags. Note this is currently ignored and kept for future use.
          * @returns Promise that resolves with the {@link TabInformation}. Contains information for the users' most recently used tabs {@link TabInstance}.
          */
         function getMruTabInstances(tabInstanceParameters) {
@@ -3626,7 +3632,7 @@ var pages;
         }
         tabs.getMruTabInstances = getMruTabInstances;
         /**
-         * Checks if the current application host supports the pages.tab capability
+         * Checks if the pages.tab capability is supported by the host
          * @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
          * false if it is disabled
          */
@@ -3636,8 +3642,8 @@ var pages;
         tabs.isSupported = isSupported;
     })(tabs = pages.tabs || (pages.tabs = {}));
     /**
-     * Namespace to interact with the config-specific part of the SDK.
-     * This object is usable only on the config frame.
+     * Provides APIs to interact with the configuration-specific part of the SDK.
+     * This object is usable only on the configuration frame.
      */
     var config;
     (function (config) {
@@ -3656,9 +3662,9 @@ var pages;
         }
         config.initialize = initialize;
         /**
-         * Sets the validity state for the config.
-         * The initial value is false, so the user cannot save the config until this is called with true.
-         * @param validityState Indicates whether the save or remove button is enabled for the user.
+         * Sets the validity state for the configuration.
+         * The initial value is false, so the user cannot save the configuration until this is called with true.
+         * @param validityState - Indicates whether the save or remove button is enabled for the user.
          */
         function setValidityState(validityState) {
             ensureInitialized(FrameContexts.settings, FrameContexts.remove);
@@ -3669,9 +3675,9 @@ var pages;
         }
         config.setValidityState = setValidityState;
         /**
-         * Sets the config for the current instance.
+         * Sets the configuration for the current instance.
          * This is an asynchronous operation; calls to getConfig are not guaranteed to reflect the changed state.
-         * @param instanceConfig The desired config for this instance.
+         * @param instanceConfig - The desired configuration for this instance.
          * @returns Promise that resolves when the operation has completed.
          */
         function setConfig(instanceConfig) {
@@ -3685,11 +3691,11 @@ var pages;
         }
         config.setConfig = setConfig;
         /**
-         * Registers a handler for when the user attempts to save the settings. This handler should be used
+         * Registers a handler for when the user attempts to save the configuration. This handler should be used
          * to create or update the underlying resource powering the content.
          * The object passed to the handler must be used to notify whether to proceed with the save.
          * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
-         * @param handler The handler to invoke when the user selects the save button.
+         * @param handler - The handler to invoke when the user selects the Save button.
          */
         function registerOnSaveHandler(handler) {
             ensureInitialized(FrameContexts.settings);
@@ -3705,7 +3711,7 @@ var pages;
          * to remove the underlying resource powering the content.
          * The object passed to the handler must be used to indicate whether to proceed with the removal.
          * Only one handler may be registered at a time. Subsequent registrations will override the first.
-         * @param handler The handler to invoke when the user selects the remove button.
+         * @param handler - The handler to invoke when the user selects the Remove button.
          */
         function registerOnRemoveHandler(handler) {
             ensureInitialized(FrameContexts.remove, FrameContexts.settings);
@@ -3728,7 +3734,7 @@ var pages;
         }
         /**
          * Registers a handler for when the tab configuration is changed by the user
-         * @param handler The handler to invoke when the user click on Settings.
+         * @param handler - The handler to invoke when the user clicks on Settings.
          */
         function registerChangeConfigHandler(handler) {
             ensureInitialized(FrameContexts.content);
@@ -3800,7 +3806,7 @@ var pages;
             return RemoveEventImpl;
         }());
         /**
-         * Checks if the current application host supports the pages.config capability
+         * Checks if the pages.config capability is supported by the host
          * @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
          * false if it is disabled
          */
@@ -3810,7 +3816,7 @@ var pages;
         config.isSupported = isSupported;
     })(config = pages.config || (pages.config = {}));
     /**
-     * Namespace to interact with the back-stack part of the SDK.
+     * Provides APIs for handling the user's navigational history.
      */
     var backStack;
     (function (backStack) {
@@ -3820,8 +3826,7 @@ var pages;
         }
         backStack._initialize = _initialize;
         /**
-         * Navigates back in the hosted app. See registerBackButtonHandler for more information on when
-         * it's appropriate to use this method.
+         * Navigates back in the hosted application. See {@link pages.backStack.registerBackButtonHandler} for notes on usage.
          * @returns Promise that resolves when the navigation has completed.
          */
         function navigateBack() {
@@ -3836,11 +3841,11 @@ var pages;
         }
         backStack.navigateBack = navigateBack;
         /**
-         * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
-         * navigation stack should use this handler to navigate the user back within their frame. If an app finds
+         * Registers a handler for user presses of the host client's back button. Experiences that maintain an internal
+         * navigation stack should use this handler to navigate the user back within their frame. If an application finds
          * that after running its back button handler it cannot handle the event it should call the navigateBack
-         * method to ask the Teams client to handle it instead.
-         * @param handler The handler to invoke when the user presses their Team client's back button.
+         * method to ask the host client to handle it instead.
+         * @param handler - The handler to invoke when the user presses the host client's back button.
          */
         function registerBackButtonHandler(handler) {
             ensureInitialized();
@@ -3857,7 +3862,7 @@ var pages;
             }
         }
         /**
-         * Checks if the current application host supports the pages.backStack capability
+         * Checks if the pages.backStack capability is supported by the host
          * @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
          * false if it is disabled
          */
@@ -3870,7 +3875,7 @@ var pages;
      * @hidden
      * Hide from docs
      * ------
-     * Namespace to interact with the full-trust part of the SDK. Limited to 1P apps
+     * Provides APIs to interact with the full-trust part of the SDK. Limited to 1P applications
      */
     var fullTrust;
     (function (fullTrust) {
@@ -3906,7 +3911,7 @@ var pages;
          * @hidden
          * Hide from docs
          * ------
-         * Checks if the current application host supports the pages.fullTrust capability
+         * Checks if the pages.fullTrust capability is supported by the host
          * @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
          * false if it is disabled
          */
@@ -3916,7 +3921,7 @@ var pages;
         fullTrust.isSupported = isSupported;
     })(fullTrust = pages.fullTrust || (pages.fullTrust = {}));
     /**
-     * Namespace to interact with the app button part of the SDK.
+     * Provides APIs to interact with the app button part of the SDK.
      */
     var appButton;
     (function (appButton) {
@@ -3960,7 +3965,7 @@ var pages;
         }
         appButton.onHoverLeave = onHoverLeave;
         /**
-         * Checks if pages.appButton capability is supported currently
+         * Checks if pages.appButton capability is supported by the host
          * @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
          * false if it is disabled
          */
@@ -6133,6 +6138,8 @@ var video;
     })(EffectChangeType = video.EffectChangeType || (video.EffectChangeType = {}));
     /**
      * Register to read the video frames in Permissions section
+     * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+     * @param config - VideoFrameConfig to customize generated video frame parameters
      */
     function registerForVideoFrame(frameCallback, config) {
         ensureInitialized(FrameContexts.sidePanel);
@@ -6148,9 +6155,9 @@ var video;
     }
     video.registerForVideoFrame = registerForVideoFrame;
     /**
-     * video extension should call this to notify Teams Client current selected effect parameter changed.
-     * If it's pre-meeting, Teams client will call videoEffectCallback immediately then use the videoEffect.
-     * in-meeting scenario, we will call videoEffectCallback when apply button clicked.
+     * video extension should call this to notify host client that the current selected effect parameter changed.
+     * If it's pre-meeting, host client will call videoEffectCallback immediately then use the videoEffect.
+     * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
      *
      * @param effectChangeType - the effect change type.
      * @param effectId - Newly selected effect id.
@@ -6164,7 +6171,8 @@ var video;
     }
     video.notifySelectedVideoEffectChanged = notifySelectedVideoEffectChanged;
     /**
-     * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied
+     * Register the video effect callback, host client uses this to notify the video extension the new video effect will by applied
+     * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
      */
     function registerForVideoEffect(callback) {
         ensureInitialized(FrameContexts.sidePanel);
@@ -6175,18 +6183,24 @@ var video;
     }
     video.registerForVideoEffect = registerForVideoEffect;
     /**
-     * Sending notification to Teams client finished the video frame processing, now Teams client can render this video frame
+     * Sending notification to host client finished the video frame processing, now host client can render this video frame
      * or pass the video frame to next one in video pipeline
      */
     function notifyVideoFrameProcessed() {
         sendMessageToParent('video.videoFrameProcessed');
     }
     /**
-     * Sending error notification to Teams client
+     * Sending error notification to host client
+     * @param errorMessage - The error message that will be sent to the host
      */
     function notifyError(errorMessage) {
         sendMessageToParent('video.notifyError', [errorMessage]);
     }
+    /**
+     * Checks if video capability is supported by the host
+     * @returns true if the video capability is enabled in runtime.supports.video and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.video ? true : false;
     }
@@ -6722,7 +6736,9 @@ function initializeWithFrameContext(frameContext, callback, validMessageOrigins)
     pages.initializeWithFrameContext(frameContext, callback, validMessageOrigins);
 }
 /**
- * Transforms the app.Context object received to TeamsJS Context
+ * Transforms the app.Context object received to the legacy global Context object
+ * @param appContext - The app.Context object to be transformed
+ * @returns The transformed legacy global Context object
  */
 function transformAppContextToLegacyContext(appContext) {
     var context = {
@@ -7300,7 +7316,7 @@ var files;
      * Hide from docs
      * ------
      *
-     * Open a cloud storage file in teams
+     * Open a cloud storage file in Teams
      *
      * @param file - cloud storage file that should be opened
      * @param providerCode - Code of the cloud storage folder provider
@@ -7403,6 +7419,9 @@ var files;
 
 
 /**
+ * @hidden
+ * Hide from docs
+ * ------
  * @internal
  */
 var legacy;
@@ -7438,6 +7457,14 @@ var legacy;
                 });
             }
             joinedTeams.getUserJoinedTeams = getUserJoinedTeams;
+            /**
+             * @hidden
+             * Hide from docs
+             * ------
+             * Checks if teams.fullTrust.joinedTeams capability is supported by the host
+             * @returns true if the teams.fullTrust.joinedTeams capability is enabled in
+             * runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
+             */
             function isSupported() {
                 return runtime.supports.teams
                     ? runtime.supports.teams.fullTrust
@@ -7469,7 +7496,12 @@ var legacy;
         }
         fullTrust.getConfigSetting = getConfigSetting;
         /**
-         * Checks if teams.fullTrust capability is supported currently
+         * @hidden
+         * Hide from docs
+         * ------
+         * Checks if teams.fullTrust capability is supported by the host
+         * @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
+         * false if it is disabled
          */
         function isSupported() {
             return runtime.supports.teams ? (runtime.supports.teams.fullTrust ? true : false) : false;
@@ -7477,7 +7509,12 @@ var legacy;
         fullTrust.isSupported = isSupported;
     })(fullTrust = legacy.fullTrust || (legacy.fullTrust = {}));
     /**
-     * Checks if teams capability is supported currently
+     * @hidden
+     * Hide from docs
+     * ------
+     * Checks if teams capability is supported by the host
+     * @returns true if the teams capability is enabled in runtime.supports.teams and
+     * false if it is disabled
      */
     function isSupported() {
         return runtime.supports.teams ? true : false;
@@ -7863,9 +7900,9 @@ var appEntity;
      * --------
      * Open the Tab Gallery and retrieve the app entity
      * @param threadId ID of the thread where the app entity will be created
-     * @param categories A list of app categories that will be displayed in the opened tab gallery
+     * @param categories A list of application categories that will be displayed in the opened tab gallery
      * @param subEntityId An object that will be made available to the application being configured
-     *                      through the Teams Context's subEntityId field.
+     *                      through the Context's subEntityId field.
      * @param callback Callback that will be triggered once the app entity information is available.
      *                 The callback takes two arguments: an SdkError in case something happened (i.e.
      *                 no permissions to execute the API) and the app entity configuration, if available
@@ -7884,6 +7921,11 @@ var appEntity;
         sendMessageToParent('appEntity.selectAppEntity', [threadId, categories, subEntityId], callback);
     }
     appEntity_1.selectAppEntity = selectAppEntity;
+    /**
+     * Checks if appEntity capability is supported by the host
+     * @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.appEntity ? true : false;
     }
@@ -7955,6 +7997,12 @@ var teams;
         sendMessageToParent('teams.refreshSiteUrl', [threadId], callback);
     }
     teams.refreshSiteUrl = refreshSiteUrl;
+    /**
+     * @hidden
+     * Checks if teams capability is supported by the host
+     * @returns true if the teams capability is enabled in runtime.supports.teams and
+     * false if it is disabled
+     */
     function isSupported() {
         return runtime.supports.teams ? true : false;
     }