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

package/dist/MicrosoftTeams.d.ts

@@ -2499,9 +2499,26 @@ export enum HostClientType {
         teamsDisplays = "teamsDisplays"
 }
 export enum HostName {
+        /**
+            * Office.com and Office Windows App
+            */
         office = "Office",
+        /**
+            * For "desktop" specifically, this refers to the new, pre-release version of Outlook for Windows.
+            * Also used on other platforms that map to a single Outlook client.
+            */
         outlook = "Outlook",
+        /**
+            * Outlook for Windows: the classic, native, desktop client
+            */
+        outlookWin32 = "OutlookWin32",
+        /**
+            * Microsoft-internal test Host
+            */
         orange = "Orange",
+        /**
+            * Teams
+            */
         teams = "Teams"
 }
 export enum FrameContexts {
@@ -3508,7 +3525,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 +4219,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 +4320,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 +4400,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 +4533,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 +4660,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
@@ -6213,13 +6166,6 @@ export namespace search {
             * Your application should *not* re-render inside of these callbacks, there may be a large number
             * of onChangeHandler calls if the user is typing rapidly in the search box.
             *
-            * @param onChangeHandler - This optional handler will be called when the user first starts using the
-            * host's search box and as the user types their query. Can be used to put your application into a
-            * word-wheeling state or to display suggestions as the user is typing.
-            *
-            * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
-            * with the current contents of the search box.
-            *
             * @param onClosedHandler - This handler will be called when the user exits or cancels their search.
             * Should be used to return your application to its most recent, non-search state. The value of {@link SearchQuery.searchTerm}
             * will be whatever the last query was before ending search.
@@ -6228,18 +6174,24 @@ export namespace search {
             * search (by pressing Enter for example). Should be used to display the full list of search results.
             * The value of {@link SearchQuery.searchTerm} is the complete query the user entered in the search box.
             *
+            * @param onChangeHandler - This optional handler will be called when the user first starts using the
+            * host's search box and as the user types their query. Can be used to put your application into a
+            * word-wheeling state or to display suggestions as the user is typing.
+            *
+            * This handler will be called with an empty {@link SearchQuery.searchTerm} when search is beginning, and subsequently,
+            * with the current contents of the search box.
             * @example
             * ``` ts
             * search.registerHandlers(
-                query => {
-                    console.log(`Update your application with the changed search query: ${query.searchTerm}`);
-                },
                 query => {
                     console.log('Update your application to handle the search experience being closed. Last query: ${query.searchTerm}');
                 },
                 query => {
                     console.log(`Update your application to handle an executed search result: ${query.searchTerm}`);
                 },
+                query => {
+                    console.log(`Update your application with the changed search query: ${query.searchTerm}`);
+                },
              );
             * ```
             *
@@ -6367,6 +6319,8 @@ export namespace stageView {
         function isSupported(): boolean;
 }
 
+export const version: string;
+
 /**
     * Contains functionality to allow web apps to store data in webview cache
     *
@@ -6885,18 +6839,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}