@microsoft/teams-js 2.2.1-beta.0 → 2.3.0-beta.2

package/LICENSE

@@ -1,12 +1,12 @@
-Microsoft Teams JS Library
-
-Copyright (c) Microsoft Corporation
-All rights reserved. 
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Microsoft Teams JS Library
+
+Copyright (c) Microsoft Corporation
+All rights reserved. 
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,74 +1,74 @@
-# Microsoft Teams JavaScript client SDK
-
-Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
-
-This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
-
-## Getting Started
-
-See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
-
-Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
-
-## Installation
-
-To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
-
-### npm
-
-`npm install --save @microsoft/teams-js`
-
-### yarn
-
-`yarn add @microsoft/teams-js`
-
-### Production
-
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js) or point your package manager at them.
-
-## Usage
-
-### As a package
-
-Install either using npm or yarn.
-
-**If you are using any dependency loader** such as [RequireJS](http://requirejs.org/) or [SystemJS](https://github.com/systemjs/systemjs) or module bundler such as [browserify](http://browserify.org/), [webpack](https://webpack.github.io/), you can use `import` syntax to import specific modules. For e.g.
-
-```typescript
-import { app } from '@microsoft/teams-js';
-```
-
-### As a script tag
-
-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.2.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-yBjE++eHeBPzIg+IKl9OHFqMbSdrzY2S/LW3qeitc5vqXewEYRWegByWzBN/chRh"
-  crossorigin="anonymous"
-></script>
-
-<!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.2.0/dist/MicrosoftTeams.min.js"></script>
-
-<!-- Microsoft Teams JavaScript API (via local) -->
-<script src="MicrosoftTeams.min.js"></script>
-```
-
-### Dependencies
-
-Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
-
-## Examples
-
-Stay tuned for examples coming soon.
-
-## Testing
-
-The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
-
-## Contributing
-
-Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.
+# Microsoft Teams JavaScript client SDK
+
+Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
+
+This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
+
+## Getting Started
+
+See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
+
+Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
+
+## Installation
+
+To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
+
+### npm
+
+`npm install --save @microsoft/teams-js`
+
+### yarn
+
+`yarn add @microsoft/teams-js`
+
+### Production
+
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+
+## Usage
+
+### As a package
+
+Install either using npm or yarn.
+
+**If you are using any dependency loader** such as [RequireJS](http://requirejs.org/) or [SystemJS](https://github.com/systemjs/systemjs) or module bundler such as [browserify](http://browserify.org/), [webpack](https://webpack.github.io/), you can use `import` syntax to import specific modules. For e.g.
+
+```typescript
+import { app } from '@microsoft/teams-js';
+```
+
+### As a script tag
+
+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.2.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-yBjE++eHeBPzIg+IKl9OHFqMbSdrzY2S/LW3qeitc5vqXewEYRWegByWzBN/chRh"
+  crossorigin="anonymous"
+></script>
+
+<!-- Microsoft Teams JavaScript API (via npm) -->
+<script src="node_modules/@microsoft/teams-js@2.2.0/dist/MicrosoftTeams.min.js"></script>
+
+<!-- Microsoft Teams JavaScript API (via local) -->
+<script src="MicrosoftTeams.min.js"></script>
+```
+
+### Dependencies
+
+Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
+
+## Examples
+
+Stay tuned for examples coming soon.
+
+## Testing
+
+The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
+
+## Contributing
+
+Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.

package/dist/MicrosoftTeams.d.ts

@@ -1989,6 +1989,166 @@ export namespace teams {
         }
 }
 
+/**
+    * @hidden
+    * Extended video API
+    * @beta
+    *
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace videoEx {
+        /**
+            * @hidden
+            * Video frame configuration supplied to the host to customize the generated video frame parameters
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface VideoFrameConfig extends video.VideoFrameConfig {
+                /**
+                    * @hidden
+                    * Flag to indicate use camera stream to synthesize video frame or not.
+                    * Default value is true.
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                requireCameraStream?: boolean;
+                /**
+                    * @hidden
+                    * Machine learning model to run in the host to do audio inference for you
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                audioInferenceModel?: ArrayBuffer;
+        }
+        /**
+            * @hidden
+            * Represents a video frame
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface VideoFrame extends video.VideoFrame {
+                /**
+                    * @hidden
+                    * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                audioInferenceResult?: Uint8Array;
+        }
+        /**
+            * @hidden
+            * Video frame call back function
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        /**
+            * @hidden
+            * Register to process video frames
+            * @beta
+            *
+            * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+            * @param config - VideoFrameConfig to customize generated video frame parameters
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
+        /**
+            * @hidden
+            * Video extension should call this to notify host that the current selected effect parameter changed.
+            * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
+            * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
+            * @beta
+            * @param effectChangeType - the effect change type.
+            * @param effectId - Newly selected effect id. {@linkcode VideoEffectCallBack}
+            * @param effectParam Variant for the newly selected effect. {@linkcode VideoEffectCallBack}
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function notifySelectedVideoEffectChanged(effectChangeType: video.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
+        /**
+            * @hidden
+            * Video effect change call back function definition
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type VideoEffectCallBack = (effectId: string | undefined, effectParam?: string) => void;
+        /**
+            * @hidden
+            * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
+            * @beta
+            * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function registerForVideoEffect(callback: VideoEffectCallBack): void;
+        /**
+            * @hidden
+            * Personalized video effect
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface PersonalizedEffect {
+                /**
+                    * Personalized effect id
+                    */
+                id: string;
+                /**
+                    * Display name
+                    */
+                name: string;
+                /**
+                    * Effect type defined by app
+                    */
+                type: string;
+                /**
+                    * Data URI of the thumbnail image content encoded in ASCII format using the base64 scheme
+                    */
+                thumbnail: string;
+        }
+        /**
+            * @hidden
+            * Send personalized effects to Teams client
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function updatePersonalizedEffects(effects: PersonalizedEffect[]): void;
+        /**
+            * @hidden
+            * Checks if video capability is supported by the host
+            * @beta
+            *
+            * @returns true if the video capability is enabled in runtime.supports.video and
+            * false if it is disabled
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function isSupported(): boolean;
+}
+
 /**
     * Namespace to interact with the authentication-specific part of the SDK.
     *
@@ -4136,6 +4296,17 @@ 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
             *
@@ -4216,6 +4387,17 @@ 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
@@ -4314,6 +4496,17 @@ export namespace pages {
                     * @param handler - The handler to invoke when the user selects the Save button.
                     */
                 function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
+                /**
+                    * @hidden
+                    * Undocumented helper function with shared code between deprecated version and current version of the registerOnSaveHandler API.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    *
+                    * @param handler - The handler to invoke when the user selects the Save button.
+                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+                    */
+                function registerOnSaveHandlerHelper(handler: (evt: SaveEvent) => void, versionSpecificHelper?: () => void): void;
                 /**
                     * Registers a handler for user attempts to remove content. This handler should be used
                     * to remove the underlying resource powering the content.
@@ -4322,11 +4515,33 @@ export namespace pages {
                     * @param handler - The handler to invoke when the user selects the Remove button.
                     */
                 function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
+                /**
+                    * @hidden
+                    * Undocumented helper function with shared code between deprecated version and current version of the registerOnRemoveHandler API.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    *
+                    * @param handler - The handler to invoke when the user selects the Remove button.
+                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+                    */
+                function registerOnRemoveHandlerHelper(handler: (evt: RemoveEvent) => void, versionSpecificHelper?: () => void): void;
                 /**
                     * Registers a handler for when the tab configuration is changed by the user
                     * @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.
@@ -4395,6 +4610,17 @@ export namespace pages {
                     * @param handler - The handler to invoke when the user presses the host client's back button.
                     */
                 function registerBackButtonHandler(handler: () => boolean): void;
+                /**
+                    * @hidden
+                    * Undocumented helper function with shared code between deprecated version and current version of the registerBackButtonHandler API.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    *
+                    * @param handler - The handler to invoke when the user presses the host client's back button.
+                    * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+                    */
+                function registerBackButtonHandlerHelper(handler: () => boolean, versionSpecificHelper?: () => void): void;
                 /**
                     * 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
@@ -4443,18 +4669,51 @@ 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
@@ -5606,6 +5865,17 @@ export namespace teamsCore {
             * @internal
             */
         function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
+        /**
+            * @hidden
+            * Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @param handler - The handler to invoke when the page is loaded.
+            * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+            */
+        function registerOnLoadHandlerHelper(handler: (context: LoadContext) => void, versionSpecificHelper?: () => void): void;
         /**
             * @hidden
             * Registers a handler to be called before the page is unloaded.
@@ -5616,6 +5886,18 @@ export namespace teamsCore {
             * @internal
             */
         function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
+        /**
+            * @hidden
+            * Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @param handler - - The handler to invoke before the page is unloaded. If this handler returns true the page should
+            * invoke the readyToUnload function provided to it once it's ready to be unloaded.
+            * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+            */
+        function registerBeforeUnloadHandlerHelper(handler: (readyToUnload: () => void) => boolean, versionSpecificHelper?: () => void): void;
         /**
             * Checks if teamsCore capability is supported by the host
             * @returns true if the teamsCore capability is enabled in runtime.supports.teamsCore and
@@ -5813,6 +6095,10 @@ export namespace video {
                     * RGB stride, valid only when video frame format is RGB
                     */
                 stride?: number;
+                /**
+                    * The time stamp of the current video frame
+                    */
+                timestamp?: number;
         }
         /**
             * Video frame format enum, currently only support NV12
@@ -5837,11 +6123,11 @@ export namespace video {
             */
         enum EffectChangeType {
                 /**
-                    * current video effect changed
+                    * Current video effect changed
                     */
                 EffectChanged = 0,
                 /**
-                    * disable the video effect
+                    * Disable the video effect
                     */
                 EffectDisabled = 1
         }
@@ -5863,8 +6149,8 @@ export namespace video {
             */
         function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
-            * 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.
+            * Video extension should call this to notify host that the current selected effect parameter changed.
+            * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
             * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
             * @beta
             * @param effectChangeType - the effect change type.
@@ -5872,7 +6158,7 @@ export namespace video {
             */
         function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
         /**
-            * Register the video effect callback, host client uses this to notify the video extension the new video effect will by applied
+            * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
             * @beta
             * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
             */
@@ -5886,6 +6172,92 @@ export namespace video {
         function isSupported(): boolean;
 }
 
+/**
+    * Allows your application to interact with the host M365 application's search box.
+    * By integrating your application with the host's search box, users can search
+    * your app using the same search box they use elsewhere in Teams, Outlook, or Office.
+    *
+    * This functionality is in Beta.
+    * @beta
+    */
+export namespace search {
+        /**
+            * This interface contains information pertaining to the contents of the host M365 application's search box
+            *
+            * @beta
+            */
+        interface SearchQuery {
+                /** The current search term in the host search experience */
+                searchTerm: string;
+                /** Timestamp sequence value to ensure messages are processed in correct order / combine them. */
+                timestamp: number;
+        }
+        /**
+            * This type will store the SearchQuery and allow other logic to be made inside the handler.
+            *
+            * @beta
+            */
+        type SearchQueryHandler = (query: SearchQuery) => void;
+        /**
+            * Allows the caller to register for various events fired by the host search experience.
+            * Calling this function indicates that your application intends to plug into the host's search box and handle search events,
+            * when the user is actively using your page/tab.
+            *
+            * The host may visually update its search box, e.g. with the name or icon of your application.
+            *
+            * 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.
+            *
+            * @param onExecuteHandler - The handler will be called when the user executes their
+            * 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.
+            *
+            * @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}`);
+                },
+             );
+            * ```
+            *
+            * @beta
+            */
+        function registerHandlers(onClosedHandler: SearchQueryHandler, onExecuteHandler: SearchQueryHandler, onChangeHandler?: SearchQueryHandler): void;
+        /**
+            * Allows the caller to unregister for all events fired by the host search experience. Calling
+            * this function will cause your app to stop appearing in the set of search scopes in the hosts
+            *
+            * @beta
+            */
+        function unregisterHandlers(): void;
+        /**
+            * Checks if search capability is supported by the host
+            * @returns true if the search capability is supported by the host and false otherwise
+            * false if it is disabled
+            *
+            * @beta
+            */
+        function isSupported(): boolean;
+}
+
 export namespace sharing {
         export const SharingAPIMessages: {
                 shareWebContent: string;