@microsoft/teams-js 2.17.0-beta.2 → 2.17.1-beta.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.16.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.17.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.16.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-v6djPeImSC5Pb0IvhWyq/XY8It8EYt0U00nPlcodpX/RN5KgChhoqkKEZs5kX5hr"
+  src="https://res.cdn.office.net/teams-js/2.17.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-xp55t/129OsN192JZYLP0rGhzjCF9aYtjY0LVtXvolkDrBe4Jchylp56NrUYJ4S2"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.16.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.17.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -1104,7 +1104,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export function getExternalProviders(excludeAddedProviders: boolean, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
+        export function getExternalProviders(excludeAddedProviders: boolean | undefined, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
         /**
             * @hidden
             * Allow 1st party apps to call this function to move files
@@ -1113,7 +1113,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean, callback: (error?: SdkError) => void): void;
+        export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean | undefined, callback: (error?: SdkError) => void): void;
         /**
             * @hidden
             * Hide from docs
@@ -1137,7 +1137,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;
+        export function openDownloadFolder(fileObjectId: string | undefined, callback: (error?: SdkError) => void): void;
         /**
             * @hidden
             * Hide from docs
@@ -3790,6 +3790,9 @@ export interface ClipboardParams {
         content: string;
 }
 
+export function appInitializeHelper(apiVersionTag: string, validMessageOrigins?: string[]): Promise<void>;
+export function registerOnThemeChangeHandlerHelper(apiVersionTag: string, handler: app.themeHandler): void;
+export function openLinkHelper(apiVersionTag: string, deepLink: string): Promise<void>;
 /**
     * Namespace to interact with app initialization and lifecycle.
     */
@@ -4233,7 +4236,7 @@ export namespace app {
             * Gets the Frame Context that the App is running in. See {@link FrameContexts} for the list of possible values.
             * @returns the Frame Context.
             */
-        function getFrameContext(): FrameContexts;
+        function getFrameContext(): FrameContexts | undefined;
         /**
             * Initializes the library.
             *
@@ -4344,14 +4347,6 @@ export namespace app {
                     * @beta
                     */
                 function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
-                /**
-                    * Checks if app.lifecycle is supported by the host.
-                    * @returns boolean to represent whether the lifecycle capability is supported
-                    * @throws Error if {@linkcode app.initialize} has not successfully completed
-                    *
-                    * @beta
-                    */
-                function isSupported(): boolean;
         }
 }
 
@@ -4551,6 +4546,10 @@ export namespace clipboard {
         function isSupported(): boolean;
 }
 
+export function updateResizeHelper(apiVersionTag: string, dimensions: DialogSize): void;
+export function urlOpenHelper(apiVersionTag: string, urlDialogInfo: UrlDialogInfo, submitHandler?: dialog.DialogSubmitHandler, messageFromChildHandler?: dialog.PostMessageChannel): void;
+export function botUrlOpenHelper(apiVersionTag: string, urlDialogInfo: BotUrlDialogInfo, submitHandler?: dialog.DialogSubmitHandler, messageFromChildHandler?: dialog.PostMessageChannel): void;
+export function urlSubmitHelper(apiVersionTag: string, result?: string | object, appIds?: string | string[]): void;
 /**
     * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
     * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
@@ -4920,6 +4919,14 @@ export namespace geoLocation {
   */
 export function getAdaptiveCardSchemaVersion(): AdaptiveCardVersion | undefined;
 
+export function navigateCrossDomainHelper(apiVersionTag: string, url: string): Promise<void>;
+export function backStackNavigateBackHelper(apiVersionTag: string): Promise<void>;
+export function tabsNavigateToTabHelper(apiVersionTag: string, tabInstance: TabInstance): Promise<void>;
+export function returnFocusHelper(apiVersionTag: string, navigateForward?: boolean): void;
+export function getTabInstancesHelper(apiVersionTag: string, tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
+export function getMruTabInstancesHelper(apiVersionTag: string, tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
+export function shareDeepLinkHelper(apiVersionTag: string, deepLinkParameters: ShareDeepLinkParameters): void;
+export function setCurrentFrameHelper(apiVersionTag: string, frameInfo: FrameInfo): void;
 /**
     * Navigation-specific part of the SDK.
     */
@@ -5255,11 +5262,11 @@ export namespace pages {
                     *
                     * @internal
                     * Limited to Microsoft-internal use
-                    *
+                    * @param apiVersionTag - The tag indicating API version number with name
                     * @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;
+                function registerBackButtonHandlerHelper(apiVersionTag: string, handler: () => boolean, versionSpecificHelper?: () => void): void;
                 /**
                     * Checks if the pages.backStack capability is supported by the host
                     * @returns boolean to represent whether the pages.backStack capability is supported
@@ -5637,15 +5644,35 @@ export namespace menus {
     * Interact with media, including capturing and viewing images.
     */
 export namespace media {
-        /** Capture image callback function type. */
+        /**
+            * Function callback type used when calling {@link media.captureImage}.
+            *
+            * @param error - Error encountered during the API call, if any, {@link SdkError}
+            * @param files - Collection of File objects (images) captured by the user. Will be an empty array in the case of an error.
+            * */
         export type captureImageCallbackFunctionType = (error: SdkError, files: File[]) => void;
-        /** Select media callback function type. */
+        /**
+            * Function callback type used when calling {@link media.selectMedia}.
+            *
+            * @param error - Error encountered during the API call, if any, {@link SdkError}
+            * @param attachments - Collection of {@link Media} objects selected by the user. Will be an empty array in the case of an error.
+            * */
         export type selectMediaCallbackFunctionType = (error: SdkError, attachments: Media[]) => void;
         /** Error callback function type. */
         export type errorCallbackFunctionType = (error?: SdkError) => void;
-        /** Scan BarCode callback function type. */
+        /**
+            * Function callback type used when calling {@link media.scanBarCode}.
+            *
+            * @param error - Error encountered during the API call, if any, {@link SdkError}
+            * @param decodedText - Decoded text from the barcode, if any. In the case of an error, this will be the empty string.
+            * */
         export type scanBarCodeCallbackFunctionType = (error: SdkError, decodedText: string) => void;
-        /** Get media callback function type. */
+        /**
+            * Function callback type used when calling {@link media.Media.getMedia}
+            *
+            * @param error - Error encountered during the API call, if any, {@link SdkError}
+            * @param blob - Blob of media returned. Will be a blob with no BlobParts, in the case of an error.
+            * */
         export type getMediaCallbackFunctionType = (error: SdkError, blob: Blob) => void;
         /**
             * Enum for file formats supported
@@ -5858,7 +5885,7 @@ export namespace media {
             */
         abstract class MediaController<T> {
                 /** Callback that can be registered to handle events related to the playback and control of video content. */
-                protected controllerCallback: T;
+                protected controllerCallback?: T;
                 constructor(controllerCallback?: T);
                 protected abstract getMediaType(): MediaType;
                 /**
@@ -6050,14 +6077,18 @@ export namespace media {
 }
 
 /**
-    * Namespace to power up the in-app browser experiences in the Host App.
-    * For e.g., opening a URL in the Host App inside a browser
+    * Namespace to power up the in-app browser experiences in the host app.
+    * For e.g., opening a URL in the host app inside a browser
     *
     * @beta
     */
 export namespace secondaryBrowser {
         /**
-            * Open a URL in the secondary browser aka in-app browser
+            * Open a URL in the secondary browser.
+            *
+            * On mobile, this is the in-app browser.
+            *
+            * On web and desktop, please use the `window.open()` method or other native external browser methods.
             *
             * @param url Url to open in the browser
             * @returns Promise that successfully resolves if the URL  opens in the secondaryBrowser
@@ -8512,7 +8543,13 @@ export namespace settings {
     * The tasks namespace will be deprecated. Please use dialog for future developments.
     */
 export namespace tasks {
-        /** Start task submit handler function type.  */
+        /**
+            * Function type that is used to receive the result when a task module is submitted by
+            * calling {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}
+            *
+            * @param err - If the task module failed, this string contains the reason for failure. If the task module succeeded, this value is the empty string.
+            * @param result - On success, this is the value passed to the `result` parameter of {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}. On failure, this is the empty string.
+            */
         type startTaskSubmitHandlerFunctionType = (err: string, result: string | object) => void;
         /**
             * @deprecated