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

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://docs.microsoft.com/javascript/api/overvi
 
 ### 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.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.3.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the SDK inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-yBjE++eHeBPzIg+IKl9OHFqMbSdrzY2S/LW3qeitc5vqXewEYRWegByWzBN/chRh"
+  src="https://res.cdn.office.net/teams-js/2.3.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-LI9E631Gz4tFN2IFwM29y0lSXUgqhkoTtdiH4ghd6eNOA1lAzX9F+D8w1NnFF9xM"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.2.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.3.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -911,7 +911,7 @@ export namespace files {
                 /**
                     * The file path to uniquely identify it within the file hierarchy
                     */
-                filePath: string;
+                webkitRelativePath?: string;
         }
         /**
             * @hidden
@@ -1006,6 +1006,7 @@ export namespace files {
         /**
             * @hidden
             * Hide from docs
+            * @beta
             *
             * Interface representing 3P cloud storage provider upload existing file(s) action
             *
@@ -1137,13 +1138,16 @@ export namespace files {
             * Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
             * 3P provider from the configured policy supported 3P provider list, following which user authentication
             * for selected 3P provider is performed on success of which the selected 3P provider support is added for user
+            * @beta
             *
-            * @param callback Callback that will be triggered post add 3P cloud storage provider action
+            * @param callback Callback that will be triggered post add 3P cloud storage provider action.
+            * If the error is encountered (and hence passed back), no provider value is sent back.
+            * For success scenarios, error value will be passed as null and a valid provider value is sent.
             *
             * @internal
             * Limited to Microsoft-internal use
             */
-        export function addCloudStorageProvider(callback: (error?: SdkError) => void): void;
+        export function addCloudStorageProvider(callback: (error?: SdkError, provider?: CloudStorageProvider) => void): void;
         /**
             * @hidden
             * Hide from docs
@@ -1218,6 +1222,7 @@ export namespace files {
             * Hide from docs
             *
             * Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
+            * @beta
             *
             * @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
             * @param callback Callback that will be triggered post uploading file(s) flow is finished
@@ -1989,6 +1994,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 +4301,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 +4392,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 +4501,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 +4520,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 +4615,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 +4674,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 +5870,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 +5891,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 +6100,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 +6128,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 +6154,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 +6163,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
             */