@microsoft/teams-js 2.19.0 → 2.20.0-beta.0

package/dist/MicrosoftTeams.d.ts

@@ -1,13 +1,5 @@
 // Generated by dts-bundle v0.7.3
 
-/**
-    * @hidden
-    * Namespace to interact with the logging part of the SDK.
-    * This object is used to send the app logs on demand to the host client
-    *
-    * @internal
-    * Limited to Microsoft-internal use
-    */
 export namespace logs {
         /**
             * @hidden
@@ -352,12 +344,6 @@ export function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes
     */
 export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
 
-/**
-    * @hidden
-    *
-    * @internal
-    * Limited to Microsoft-internal use
-    */
 export interface OpenConversationRequest {
         /**
             * @hidden
@@ -889,14 +875,6 @@ export namespace externalAppCardActions {
         function isSupported(): boolean;
 }
 
-/**
-    * @hidden
-    *
-    * Namespace to interact with the files specific part of the SDK.
-    *
-    * @internal
-    * Limited to Microsoft-internal use
-    */
 export namespace files {
         /**
             * @hidden
@@ -1415,7 +1393,9 @@ export namespace files {
             * @hidden
             * Hide from docs
             *
-            * Gets a list of cloud storage folders added to the channel
+            * Gets a list of cloud storage folders added to the channel. This function will not timeout;
+            * the callback will only return when the host responds with a list of folders or error.
+            *
             * @param channelId - ID of the channel whose cloud storage folders should be retrieved
             * @param callback - Callback that will be triggered post folders load
             *
@@ -1653,12 +1633,6 @@ export namespace files {
         export {};
 }
 
-/**
-    * @hidden
-    *
-    * @internal
-    * Limited to Microsoft-internal use
-    */
 export namespace meetingRoom {
         /**
             * @hidden
@@ -1863,13 +1837,6 @@ export namespace meetingRoom {
         export {};
 }
 
-/**
-    * @hidden
-    * Hidden from Docs
-    *
-    * @internal
-    * Limited to Microsoft-internal use
-    */
 export namespace notifications {
         /**
             * @hidden
@@ -2684,10 +2651,10 @@ export namespace authentication {
             * @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow
             *
             * @returns `Promise` that will be fulfilled with the result from the authentication pop-up, if successful. The string in this result is provided in the parameter
-            * passed by your app when it calls {@link notifySuccess} in the pop-up window after returning from the identity provider redirect.
+            * passed by your app when it calls {@link authentication.notifySuccess authentication.notifySuccess(result?: string): void} in the pop-up window after returning from the identity provider redirect.
             *
             * @throws `Error` if the authentication request fails or is canceled by the user. This error is provided in the parameter passed by your app when it calls
-            * {@link notifyFailure} in the pop-up window after returning from the identity provider redirect. However, in some cases it can also be provided by
+            * {@link authentication.notifyFailure authentication.notifyFailure(result?: string): void} in the pop-up window after returning from the identity provider redirect. However, in some cases it can also be provided by
             * the infrastructure depending on the failure (e.g., a user cancelation)
             *
             */
@@ -2765,9 +2732,8 @@ export namespace authentication {
             *
             * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
             * this value in its callback or via the `Promise` return value
-            * @param callbackUrl - Specifies the url to redirect back to if the client is Win32 Outlook.
             */
-        function notifySuccess(result?: string, callbackUrl?: string): void;
+        function notifySuccess(result?: string): void;
         /**
             * When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
             * window that was opened to execute the authentication flow should call this method after authentiction to notify the caller of
@@ -2781,9 +2747,9 @@ export namespace authentication {
             *
             * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
             * this value in its callback or via the `Promise` return value
-            * @param callbackUrl - Specifies the url to redirect back to if the client is Win32 Outlook.
+            * @param _callbackUrl - This parameter is deprecated and unused
             */
-        function notifyFailure(reason?: string, callbackUrl?: string): void;
+        function notifyFailure(result?: string): void;
         /**
             * @deprecated
             * As of 2.0.0, this interface has been deprecated in favor of leveraging the `Promise` returned from {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
@@ -2859,6 +2825,10 @@ export namespace authentication {
                     * An optional flag indicating whether to attempt the token acquisition silently or allow a prompt to be shown.
                     */
                 silent?: boolean;
+                /**
+                    * An optional identifier of the home tenant for which to acquire the acess token for (used in cross-tenant shared channels).
+                    */
+                tenantId?: string;
         }
         /**
             * @deprecated
@@ -4823,11 +4793,6 @@ export namespace barCode {
         function isSupported(): boolean;
 }
 
-/**
-    * Describes information needed to start a chat
-    *
-    * @beta
-    */
 interface OpenChatRequest {
         /**
             * An optional message used when initiating chat
@@ -5035,35 +5000,55 @@ export namespace dialog {
                     */
                 function submit(result?: string | object, appIds?: string | string[]): void;
                 /**
-                    *  Send message to the parent from dialog
+                    * Subcapability that allows communication between the dialog and the parent app.
                     *
                     * @remarks
-                    * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
-                    *
-                    * @param message - The message to send to the parent
+                    * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
                     *
                     * @beta
                     */
-                function sendMessageToParentFromDialog(message: any): void;
-                /**
-                    *  Send message to the dialog from the parent
-                    *
-                    * @param message - The message to send
-                    *
-                    * @beta
-                    */
-                function sendMessageToDialog(message: any): void;
-                /**
-                    * Register a listener that will be triggered when a message is received from the app that opened the dialog.
-                    *
-                    * @remarks
-                    * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
-                    *
-                    * @param listener - The listener that will be triggered.
-                    *
-                    * @beta
-                    */
-                function registerOnMessageFromParent(listener: PostMessageChannel): void;
+                namespace parentCommunication {
+                        /**
+                            *  Send message to the parent from dialog
+                            *
+                            * @remarks
+                            * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
+                            *
+                            * @param message - The message to send to the parent
+                            *
+                            * @beta
+                            */
+                        function sendMessageToParentFromDialog(message: any): void;
+                        /**
+                            *  Send message to the dialog from the parent
+                            *
+                            * @param message - The message to send
+                            *
+                            * @beta
+                            */
+                        function sendMessageToDialog(message: any): void;
+                        /**
+                            * Register a listener that will be triggered when a message is received from the app that opened the dialog.
+                            *
+                            * @remarks
+                            * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
+                            *
+                            * @param listener - The listener that will be triggered.
+                            *
+                            * @beta
+                            */
+                        function registerOnMessageFromParent(listener: PostMessageChannel): void;
+                        /**
+                            * Checks if dialog.url.parentCommunication capability is supported by the host
+                            *
+                            * @returns boolean to represent whether dialog.url.parentCommunication capability is supported
+                            *
+                            * @throws Error if {@linkcode app.initialize} has not successfully completed
+                            *
+                            * @beta
+                            */
+                        function isSupported(): boolean;
+                }
                 /**
                     * Checks if dialog.url module is supported by the host
                     *
@@ -5325,6 +5310,9 @@ export function getTabInstancesHelper(apiVersionTag: string, tabInstanceParamete
 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;
+export function configSetValidityStateHelper(apiVersionTag: string, validityState: boolean): void;
+export function getConfigHelper(apiVersionTag: string): Promise<pages.InstanceConfig>;
+export function configSetConfigHelper(apiVersionTag: string, instanceConfig: pages.InstanceConfig): Promise<void>;
 /**
     * Navigation-specific part of the SDK.
     */
@@ -5550,10 +5538,11 @@ export namespace pages {
                     * @internal
                     * Limited to Microsoft-internal use
                     *
+                    * @param apiVersionTag - The API version tag, which is used for telemetry, composed by API version number and source API name.
                     * @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;
+                function registerOnSaveHandlerHelper(apiVersionTag: string, 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.
@@ -5569,10 +5558,11 @@ export namespace pages {
                     * @internal
                     * Limited to Microsoft-internal use
                     *
+                    * @param apiVersionTag - The API version tag, which is used for telemetry, composed by API version number and source API name.
                     * @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;
+                function registerOnRemoveHandlerHelper(apiVersionTag: string, 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.
@@ -5678,6 +5668,8 @@ export namespace pages {
             * Hide from docs
             * ------
             * Provides APIs to interact with the full-trust part of the SDK. Limited to 1P applications
+            * @internal
+            * Limited to Microsoft-internal use
             */
         namespace fullTrust {
                 /**
@@ -5685,6 +5677,7 @@ export namespace pages {
                     * Hide from docs
                     * ------
                     * Place the tab into full-screen mode.
+                    *
                     */
                 function enterFullscreen(): void;
                 /**
@@ -7362,13 +7355,6 @@ export namespace meeting {
         function updateMicState(micState: MicState): void;
 }
 
-/**
-    * @hidden
-    * Hidden from Docs
-    *
-    * @internal
-    * Limited to Microsoft-internal use
-    */
 export namespace monetization {
         /**
             * @hidden
@@ -7645,9 +7631,6 @@ export namespace teamsCore {
         function isSupported(): boolean;
 }
 
-/**
-    * Allows your app to add a people picker enabling users to search for and select people in their organization.
-    */
 export namespace people {
         /** Select people callback function type */
         type selectPeopleCallbackFunctionType = (error: SdkError, people: PeoplePickerResult[]) => void;
@@ -8661,6 +8644,16 @@ export namespace appInitialization {
     * @beta
     */
 export namespace thirdPartyCloudStorage {
+        /**
+            * Interface to assemble file chunks
+            * @beta
+            */
+        interface AssembleAttachment {
+                /** A number representing the sequence of the attachment in the file chunks. */
+                sequence: number;
+                /** A Blob object representing the data of the file chunks. */
+                file: Blob;
+        }
         /**
             * Object used to represent a file
             * @beta
@@ -8732,26 +8725,6 @@ export namespace thirdPartyCloudStorage {
                     */
                 fileName: string;
         }
-        /**
-            * Interface to assemble file chunks
-            * @beta
-            */
-        interface AssembleAttachment {
-                /** A number representing the sequence of the attachment in the file chunks. */
-                sequence: number;
-                /** A Blob object representing the data of the file chunks. */
-                file: Blob;
-        }
-        /**
-            * Interface to assemble files
-            * @beta
-            */
-        interface AttachmentListHelper {
-                /** A string representing the MIME type of the file */
-                fileType: string;
-                /** An array of {@link AssembleAttachment | AssembleAttachment} objects representing files to be sent as attachment */
-                assembleAttachment: AssembleAttachment[];
-        }
         /**
             * Defines the callback function received from Third Party App
             * @beta
@@ -9773,7 +9746,7 @@ export { VideoEffectCallBack as DefaultVideoEffectCallBack };
     * This class is used to monitor the performance of video processing, and report performance events.
     */
 export class VideoPerformanceMonitor {
-        constructor(reportPerformanceEvent: (actionName: string, args: unknown[]) => void);
+        constructor(reportPerformanceEvent: (apiVersionTag: string, actionName: string, args: unknown[]) => void);
         /**
             * Start to check frame processing time intervally
             * and report performance event if the average frame processing time is too long.