@microsoft/teams-js 2.3.0 → 2.3.1-beta.0

package/dist/MicrosoftTeams.d.ts

@@ -3508,7 +3508,7 @@ export namespace app {
                     */
                 locale: string;
                 /**
-                    * The current UI theme.
+                    * The current UI theme of the host. Possible values: "default", "dark", or "contrast".
                     */
                 theme: string;
                 /**
@@ -4202,7 +4202,9 @@ export namespace geoLocation {
                      */
                 longitude: number;
                 /**
-                    Accuracy of the coordinates captured
+                    Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
+                    @remarks
+                    This property is only in scope for mobile
                      */
                 accuracy?: number;
                 /**
@@ -4301,17 +4303,6 @@ export namespace pages {
             * Limited to Microsoft-internal use
             */
         function registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void;
-        /**
-            * @hidden
-            * Undocumented helper function with shared code between deprecated version and current version of the registerFocusEnterHandler API.
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            *
-            * @param handler - The handler for placing focus within the application.
-            * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-            */
-        function registerFocusEnterHandlerHelper(handler: (navigateForward: boolean) => void, versionSpecificHelper?: () => void): void;
         /**
             * Sets/Updates the current frame with new information
             *
@@ -4392,17 +4383,6 @@ export namespace pages {
             * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
             */
         function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
-        /**
-            * @hidden
-            * Undocumented helper function with shared code between deprecated version and current version of the registerFullScreenHandler API.
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            *
-            * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
-            * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-            */
-        function registerFullScreenHandlerHelper(handler: (isFullScreen: boolean) => void, versionSpecificHelper?: () => void): void;
         /**
             * Checks if the pages capability is supported by the host
             * @returns true if the pages capability is enabled in runtime.supports.pages and
@@ -4536,17 +4516,6 @@ export namespace pages {
                     * @param handler - The handler to invoke when the user clicks on Settings.
                     */
                 function registerChangeConfigHandler(handler: () => void): void;
-                /**
-                    * @hidden
-                    * Undocumented helper function with shared code between deprecated version and current version of the registerConfigChangeHandler API.
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    *
-                    * @param handler - The handler to invoke when the user clicks on Settings.
-                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-                    */
-                function registerChangeConfigHandlerHelper(handler: () => void, versionSpecificHelper?: () => 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.
@@ -4674,51 +4643,18 @@ export namespace pages {
                     * @param handler - The handler to invoke when the personal app button is clicked in the app bar.
                     */
                 function onClick(handler: () => void): void;
-                /**
-                    * @hidden
-                    * Undocumented helper function with shared code between deprecated version and current version of the onClick API.
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    *
-                    * @param handler - The handler to invoke when the personal app button is clicked in the app bar.
-                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-                    */
-                function onClickHelper(handler: () => void, versionSpecificHelper?: () => void): void;
                 /**
                     * 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.
                     * @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
                     */
                 function onHoverEnter(handler: () => void): void;
-                /**
-                    * @hidden
-                    * Undocumented helper function with shared code between deprecated version and current version of the onHoverEnter API.
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    *
-                    * @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
-                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-                    */
-                function onHoverEnterHelper(handler: () => void, versionSpecificHelper?: () => void): void;
                 /**
                     * 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.
                     * @param handler - The handler to invoke when exiting hover of the personal app button in the app bar.
                     */
                 function onHoverLeave(handler: () => void): void;
-                /**
-                    * @hidden
-                    * Undocumented helper function with shared code between deprecated version and current version of the onHoverLeave API.
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    *
-                    * @param handler - The handler to invoke when existing hover of the personal app button in the app bar.
-                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-                    */
-                function onHoverLeaveHelper(handler: () => void, versionSpecificHelper?: () => void): void;
                 /**
                     * 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
@@ -6885,18 +6821,6 @@ export namespace tasks {
             * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
             */
         function submitTask(result?: string | object, appIds?: string | string[]): void;
-        /**
-            * Converts {@link TaskInfo} to {@link UrlDialogInfo}
-            * @param taskInfo - TaskInfo object to convert
-            * @returns - Converted UrlDialogInfo object
-            */
-        function getUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): UrlDialogInfo;
-        /**
-            * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
-            * @param taskInfo - TaskInfo object to convert
-            * @returns - converted BotUrlDialogInfo object
-            */
-        function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
         /**
             * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
             * otherwise uses the height and width values corresponding to {@link TaskModuleDimension | TaskModuleDimension.Small}

package/dist/MicrosoftTeams.js

@@ -1129,7 +1129,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.3.0";
+var version = "2.3.1-beta.0";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -3468,31 +3468,13 @@ var pages;
      * Limited to Microsoft-internal use
      */
     function registerFocusEnterHandler(handler) {
-        ensureInitialized();
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
-        registerHandler('focusEnter', handler);
+        registerHandlerHelper('focusEnter', handler, [], function () {
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+        });
     }
     pages.registerFocusEnterHandler = registerFocusEnterHandler;
-    /**
-     * @hidden
-     * Undocumented helper function with shared code between deprecated version and current version of the registerFocusEnterHandler API.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @param handler - The handler for placing focus within the application.
-     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-     */
-    function registerFocusEnterHandlerHelper(handler, versionSpecificHelper) {
-        ensureInitialized();
-        if (versionSpecificHelper) {
-            versionSpecificHelper();
-        }
-        registerHandler('focusEnter', handler);
-    }
-    pages.registerFocusEnterHandlerHelper = registerFocusEnterHandlerHelper;
     /**
      * Sets/Updates the current frame with new information
      *
@@ -3602,31 +3584,13 @@ var pages;
      * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
      */
     function registerFullScreenHandler(handler) {
-        ensureInitialized();
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
-        registerHandler('fullScreenChange', handler);
+        registerHandlerHelper('fullScreenChange', handler, [], function () {
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+        });
     }
     pages.registerFullScreenHandler = registerFullScreenHandler;
-    /**
-     * @hidden
-     * Undocumented helper function with shared code between deprecated version and current version of the registerFullScreenHandler API.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
-     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-     */
-    function registerFullScreenHandlerHelper(handler, versionSpecificHelper) {
-        ensureInitialized();
-        if (versionSpecificHelper) {
-            versionSpecificHelper();
-        }
-        registerHandler('fullScreenChange', handler);
-    }
-    pages.registerFullScreenHandlerHelper = registerFullScreenHandlerHelper;
     /**
      * Checks if the pages capability is supported by the host
      * @returns true if the pages capability is enabled in runtime.supports.pages and
@@ -3832,31 +3796,13 @@ var pages;
          * @param handler - The handler to invoke when the user clicks on Settings.
          */
         function registerChangeConfigHandler(handler) {
-            registerChangeConfigHandlerHelper(handler, function () {
+            registerHandlerHelper('changeSettings', handler, [FrameContexts.content], function () {
                 if (!isSupported()) {
                     throw errorNotSupportedOnPlatform;
                 }
             });
         }
         config.registerChangeConfigHandler = registerChangeConfigHandler;
-        /**
-         * @hidden
-         * Undocumented helper function with shared code between deprecated version and current version of the registerConfigChangeHandler API.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         *
-         * @param handler - The handler to invoke when the user clicks on Settings.
-         * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-         */
-        function registerChangeConfigHandlerHelper(handler, versionSpecificHelper) {
-            ensureInitialized(FrameContexts.content);
-            if (versionSpecificHelper) {
-                versionSpecificHelper();
-            }
-            registerHandler('changeSettings', handler);
-        }
-        config.registerChangeConfigHandlerHelper = registerChangeConfigHandlerHelper;
         /**
          * @hidden
          * Hide from docs, since this class is not directly used.
@@ -4062,93 +4008,39 @@ var pages;
          * @param handler - The handler to invoke when the personal app button is clicked in the app bar.
          */
         function onClick(handler) {
-            onClickHelper(handler, function () {
+            registerHandlerHelper('appButtonClick', handler, [FrameContexts.content], function () {
                 if (!isSupported()) {
                     throw errorNotSupportedOnPlatform;
                 }
             });
         }
         appButton.onClick = onClick;
-        /**
-         * @hidden
-         * Undocumented helper function with shared code between deprecated version and current version of the onClick API.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         *
-         * @param handler - The handler to invoke when the personal app button is clicked in the app bar.
-         * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-         */
-        function onClickHelper(handler, versionSpecificHelper) {
-            ensureInitialized(FrameContexts.content);
-            if (versionSpecificHelper) {
-                versionSpecificHelper();
-            }
-            registerHandler('appButtonClick', handler);
-        }
-        appButton.onClickHelper = onClickHelper;
         /**
          * 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.
          * @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
          */
         function onHoverEnter(handler) {
-            onHoverEnterHelper(handler, function () {
+            registerHandlerHelper('appButtonHoverEnter', handler, [FrameContexts.content], function () {
                 if (!isSupported()) {
                     throw errorNotSupportedOnPlatform;
                 }
             });
         }
         appButton.onHoverEnter = onHoverEnter;
-        /**
-         * @hidden
-         * Undocumented helper function with shared code between deprecated version and current version of the onHoverEnter API.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         *
-         * @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
-         * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-         */
-        function onHoverEnterHelper(handler, versionSpecificHelper) {
-            ensureInitialized(FrameContexts.content);
-            if (versionSpecificHelper) {
-                versionSpecificHelper();
-            }
-            registerHandler('appButtonHoverEnter', handler);
-        }
-        appButton.onHoverEnterHelper = onHoverEnterHelper;
         /**
          * 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.
          * @param handler - The handler to invoke when exiting hover of the personal app button in the app bar.
          */
         function onHoverLeave(handler) {
-            onHoverLeaveHelper(handler, function () {
+            registerHandlerHelper('appButtonHoverLeave', handler, [FrameContexts.content], function () {
                 if (!isSupported()) {
                     throw errorNotSupportedOnPlatform;
                 }
             });
         }
         appButton.onHoverLeave = onHoverLeave;
-        /**
-         * @hidden
-         * Undocumented helper function with shared code between deprecated version and current version of the onHoverLeave API.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         *
-         * @param handler - The handler to invoke when existing hover of the personal app button in the app bar.
-         * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-         */
-        function onHoverLeaveHelper(handler, versionSpecificHelper) {
-            ensureInitialized(FrameContexts.content);
-            if (versionSpecificHelper) {
-                versionSpecificHelper();
-            }
-            registerHandler('appButtonHoverLeave', handler);
-        }
-        appButton.onHoverLeaveHelper = onHoverLeaveHelper;
         /**
          * 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
@@ -4190,6 +4082,7 @@ var __spreadArray = (undefined && undefined.__spreadArray) || function (to, from
 
 
 
+
 var handlersLogger = getLogger('handlers');
 /**
  * @internal
@@ -4251,10 +4144,32 @@ function registerHandler(name, handler, sendMessage, args) {
 function removeHandler(name) {
     delete HandlersPrivate.handlers[name];
 }
-/** @internal */
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
 function doesHandlerExist(name) {
     return HandlersPrivate.handlers[name] != null;
 }
+/**
+ * @hidden
+ * Undocumented helper function with shared code between deprecated version and current version of register*Handler APIs
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @param name - The name of the handler to register.
+ * @param handler - The handler to invoke.
+ * @param contexts - The context within which it is valid to register this handler.
+ * @param registrationHelper - The helper function containing logic pertaining to a specific version of the API.
+ */
+function registerHandlerHelper(name, handler, contexts, registrationHelper) {
+    ensureInitialized.apply(void 0, contexts);
+    if (registrationHelper) {
+        registrationHelper();
+    }
+    registerHandler(name, handler);
+}
 /**
  * @internal
  * Limited to Microsoft-internal use
@@ -7488,6 +7403,7 @@ var appInitialization;
 
 
 
+
 /**
  * @deprecated
  * As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
@@ -7588,7 +7504,7 @@ function registerOnThemeChangeHandler(handler) {
  * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
  */
 function registerFullScreenHandler(handler) {
-    pages.registerFullScreenHandlerHelper(handler);
+    registerHandlerHelper('fullScreenChange', handler, []);
 }
 /**
  * @deprecated
@@ -7600,7 +7516,7 @@ function registerFullScreenHandler(handler) {
  * @param handler - The handler to invoke when the personal app button is clicked in the app bar.
  */
 function registerAppButtonClickHandler(handler) {
-    pages.appButton.onClickHelper(handler);
+    registerHandlerHelper('appButtonClick', handler, [FrameContexts.content]);
 }
 /**
  * @deprecated
@@ -7612,7 +7528,7 @@ function registerAppButtonClickHandler(handler) {
  * @param handler - The handler to invoke when entering hover of the personal app button in the app bar.
  */
 function registerAppButtonHoverEnterHandler(handler) {
-    pages.appButton.onHoverEnterHelper(handler);
+    registerHandlerHelper('appButtonHoverEnter', handler, [FrameContexts.content]);
 }
 /**
  * @deprecated
@@ -7624,7 +7540,7 @@ function registerAppButtonHoverEnterHandler(handler) {
  *
  */
 function registerAppButtonHoverLeaveHandler(handler) {
-    pages.appButton.onHoverLeaveHelper(handler);
+    registerHandlerHelper('appButtonHoverLeave', handler, [FrameContexts.content]);
 }
 /**
  * @deprecated
@@ -7675,7 +7591,7 @@ function registerBeforeUnloadHandler(handler) {
  * @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
  */
 function registerFocusEnterHandler(handler) {
-    pages.registerFocusEnterHandlerHelper(handler);
+    registerHandlerHelper('focusEnter', handler, []);
 }
 /**
  * @deprecated
@@ -7686,7 +7602,7 @@ function registerFocusEnterHandler(handler) {
  * @param handler - The handler to invoke when the user click on Settings.
  */
 function registerChangeSettingsHandler(handler) {
-    pages.config.registerChangeConfigHandlerHelper(handler);
+    registerHandlerHelper('changeSettings', handler, [FrameContexts.content]);
 }
 /**
  * @deprecated
@@ -8142,7 +8058,6 @@ var tasks;
         };
         return urldialogInfo;
     }
-    tasks.getUrlDialogInfoFromTaskInfo = getUrlDialogInfoFromTaskInfo;
     /**
      * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
      * @param taskInfo - TaskInfo object to convert
@@ -8161,7 +8076,6 @@ var tasks;
         };
         return botUrldialogInfo;
     }
-    tasks.getBotUrlDialogInfoFromTaskInfo = getBotUrlDialogInfoFromTaskInfo;
     /**
      * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
      * otherwise uses the height and width values corresponding to {@link TaskModuleDimension | TaskModuleDimension.Small}