@microsoft/teams-js 2.18.0 → 2.19.0-beta.1

package/dist/MicrosoftTeams.d.ts

@@ -156,6 +156,14 @@ export interface FilePreviewParameters {
             * Limited to Microsoft-internal use
             */
         type: string;
+        /**
+            * @hidden
+            * The size of the file in bytes.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        sizeInBytes?: number;
         /**
             * @hidden
             * A url to the source of the file, used to open the content in the user's default browser
@@ -502,6 +510,385 @@ export namespace conversations {
         function isSupported(): boolean;
 }
 
+/**
+    * @hidden
+    * Namespace to delegate authentication and message extension requests to the host
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace externalAppAuthentication {
+        /**
+            * @hidden
+            * Information about the bot request that should be resent by the host
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type IOriginalRequestInfo = IQueryMessageExtensionRequest | IActionExecuteInvokeRequest;
+        /**
+            * @hidden
+            * Parameters for the authentication pop-up. This interface is used exclusively with the externalAppAuthentication APIs
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type AuthenticatePopUpParameters = {
+                /**
+                    * The URL for the authentication pop-up.
+                    */
+                url: URL;
+                /**
+                    * The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
+                    */
+                width?: number;
+                /**
+                    * The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
+                    */
+                height?: number;
+                /**
+                    * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
+                    * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page specified in
+                    * the {@link url} property to be opened in an external browser.
+                    * If this flag is `false`, the page will be opened directly within the current hosting application.
+                    *
+                    * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
+                    * environment without an embedded browser.
+                    */
+                isExternal?: boolean;
+        };
+        /**
+            * @hidden
+            * Parameters for SSO authentication. This interface is used exclusively with the externalAppAuthentication APIs
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type AuthTokenRequestParameters = {
+                /**
+                    * An optional list of claims which to pass to Microsoft Entra when requesting the access token.
+                    */
+                claims?: string[];
+                /**
+                    * An optional flag indicating whether to attempt the token acquisition silently or allow a prompt to be shown.
+                    */
+                silent?: boolean;
+        };
+        /**
+            * @hidden
+            * Information about the message extension request that should be resent by the host. Corresponds to request schema in https://learn.microsoft.com/en-us/microsoftteams/platform/resources/messaging-extension-v3/search-extensions#receive-user-requests
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IQueryMessageExtensionRequest {
+                requestType: OriginalRequestType.QueryMessageExtensionRequest;
+                commandId: string;
+                parameters: {
+                        name: string;
+                        value: string;
+                }[];
+                queryOptions?: {
+                        count: number;
+                        skip: number;
+                };
+        }
+        /**
+            * @hidden
+            * Information about the Action.Execute request that should be resent by the host. Corresponds to schema in https://adaptivecards.io/explorer/Action.Execute.html
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IActionExecuteInvokeRequest {
+                requestType: OriginalRequestType.ActionExecuteInvokeRequest;
+                type: string;
+                id: string;
+                verb: string;
+                data: string | Record<string, unknown>;
+        }
+        /**
+            * @hidden
+            * Used to differentiate between IOriginalRequestInfo types
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum OriginalRequestType {
+                ActionExecuteInvokeRequest = "ActionExecuteInvokeRequest",
+                QueryMessageExtensionRequest = "QueryMessageExtensionRequest"
+        }
+        /**
+            * @hidden
+            * The response from the bot returned via the host
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type IInvokeResponse = IQueryMessageExtensionResponse | IActionExecuteResponse;
+        /**
+            * @hidden
+            * Used to differentiate between IInvokeResponse types
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum InvokeResponseType {
+                ActionExecuteInvokeResponse = "ActionExecuteInvokeResponse",
+                QueryMessageExtensionResponse = "QueryMessageExtensionResponse"
+        }
+        /**
+            * @hidden
+            * The response from the bot returned via the host for a message extension query request.
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IQueryMessageExtensionResponse {
+                responseType: InvokeResponseType.QueryMessageExtensionResponse;
+                composeExtension?: ComposeExtensionResponse;
+        }
+        /**
+            * @hidden
+            * The response from the bot returned via the host for an Action.Execute request.
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IActionExecuteResponse {
+                responseType: InvokeResponseType.ActionExecuteInvokeResponse;
+                value: Record<string, unknown>;
+                signature?: string;
+                statusCode: number;
+                type: string;
+        }
+        /**
+            * @hidden
+            * The compose extension response returned for a message extension query request. `suggestedActions` will be present only when the type is is 'config' or 'auth'.
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type ComposeExtensionResponse = {
+                attachmentLayout: AttachmentLayout;
+                type: ComposeResultTypes;
+                attachments?: QueryMessageExtensionAttachment[];
+                suggestedActions?: QueryMessageExtensionSuggestedActions;
+                text?: string;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type QueryMessageExtensionSuggestedActions = {
+                actions: Action[];
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type Action = {
+                type: string;
+                title: string;
+                value: string;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type QueryMessageExtensionCard = {
+                contentType: string;
+                content: Record<string, unknown>;
+                fallbackHtml?: string;
+                signature?: string;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type QueryMessageExtensionAttachment = QueryMessageExtensionCard & {
+                preview?: QueryMessageExtensionCard;
+        };
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type AttachmentLayout = 'grid' | 'list';
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type ComposeResultTypes = 'auth' | 'config' | 'message' | 'result' | 'silentAuth';
+        /*********** BEGIN ERROR TYPE ***********/
+        interface InvokeError {
+                errorCode: InvokeErrorCode;
+                message?: string;
+        }
+        /**
+            * @hidden
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum InvokeErrorCode {
+                INTERNAL_ERROR = "INTERNAL_ERROR"
+        }
+        /**
+            * @beta
+            * @hidden
+            * Signals to the host to perform authentication using the given authentication parameters and then resend the request to the application specified by the app ID with the authentication result.
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application backend to which the request and authentication response should be sent. This must be a UUID
+            * @param authenticateParameters Parameters for the authentication pop-up
+            * @param originalRequestInfo Information about the original request that should be resent
+            * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
+            */
+        function authenticateAndResendRequest(appId: string, authenticateParameters: AuthenticatePopUpParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
+        /**
+            * @beta
+            * @hidden
+            * Signals to the host to perform SSO authentication for the application specified by the app ID
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application backend for which the host should attempt SSO authentication. This must be a UUID
+            * @param authTokenRequest Parameters for SSO authentication
+            * @returns A promise that resolves when authentication and succeeds and rejects with InvokeError on failure
+            */
+        function authenticateWithSSO(appId: string, authTokenRequest: AuthTokenRequestParameters): Promise<void>;
+        /**
+            * @beta
+            * @hidden
+            * Signals to the host to perform SSO authentication for the application specified by the app ID and then resend the request to the application backend with the authentication result
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application backend for which the host should attempt SSO authentication and resend the request and authentication response. This must be a UUID.
+            * @param authTokenRequest Parameters for SSO authentication
+            * @param originalRequestInfo Information about the original request that should be resent
+            * @returns A promise that resolves to the IInvokeResponse from the application backend and rejects with InvokeError if the host encounters an error while authenticating or resending the request
+            */
+        function authenticateWithSSOAndResendRequest(appId: string, authTokenRequest: AuthTokenRequestParameters, originalRequestInfo: IOriginalRequestInfo): Promise<IInvokeResponse>;
+        /**
+            * @hidden
+            * Checks if the externalAppAuthentication capability is supported by the host
+            * @returns boolean to represent whether externalAppAuthentication capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function isSupported(): boolean;
+}
+
+/**
+    * @hidden
+    * Namespace to delegate adaptive card action execution to the host
+    * @internal
+    * Limited to Microsoft-internal use
+    */
+export namespace externalAppCardActions {
+        /**
+            * @hidden
+            * The type of deeplink action that was executed by the host
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ActionOpenUrlType {
+                DeepLinkDialog = "DeepLinkDialog",
+                DeepLinkOther = "DeepLinkOther",
+                DeepLinkStageView = "DeepLinkStageView",
+                GenericUrl = "GenericUrl"
+        }
+        /**
+            * @hidden
+            * Error that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface ActionOpenUrlError {
+                errorCode: ActionOpenUrlErrorCode;
+                message?: string;
+        }
+        /**
+            * @hidden
+            * Error codes that can be thrown from IExternalAppCardActionService.handleActionOpenUrl
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ActionOpenUrlErrorCode {
+                INTERNAL_ERROR = "INTERNAL_ERROR",
+                INVALID_LINK = "INVALID_LINK",
+                NOT_SUPPORTED = "NOT_SUPPORTED"
+        }
+        /**
+            * @hidden
+            * The payload that is used when executing an Adaptive Card Action.Submit
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface IAdaptiveCardActionSubmit {
+                id: string;
+                data: string | Record<string, unknown>;
+        }
+        /**
+            *
+            * @hidden
+            * Error that can be thrown from IExternalAppCardActionService.handleActionSubmit
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface ActionSubmitError {
+                errorCode: ActionSubmitErrorCode;
+                message?: string;
+        }
+        /**
+            * @hidden
+            * Error codes that can be thrown from IExternalAppCardActionService.handleActionSubmit
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ActionSubmitErrorCode {
+                INTERNAL_ERROR = "INTERNAL_ERROR"
+        }
+        /**
+            * @beta
+            * @hidden
+            * Delegates an Adaptive Card Action.Submit request to the host for the application with the provided app ID
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application the request is intended for. This must be a UUID
+            * @param actionSubmitPayload The Adaptive Card Action.Submit payload
+            * @param cardActionsConfig The card actions configuration. This indicates which subtypes should be handled by this API
+            * @returns Promise that resolves when the request is completed and rejects with ActionSubmitError if the request fails
+            */
+        function processActionSubmit(appId: string, actionSubmitPayload: IAdaptiveCardActionSubmit): Promise<void>;
+        /**
+            * @beta
+            * @hidden
+            * Delegates an Adaptive Card Action.OpenUrl request to the host for the application with the provided app ID
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param appId ID of the application the request is intended for. This must be a UUID
+            * @param url The URL to open
+            * @returns Promise that resolves to ActionOpenUrlType indicating the type of URL that was opened on success and rejects with ActionOpenUrlError if the request fails
+            */
+        function processActionOpenUrl(appId: string, url: URL): Promise<ActionOpenUrlType>;
+        /**
+            * @hidden
+            * Checks if the externalAppCardActions capability is supported by the host
+            * @returns boolean to represent whether externalAppCardActions capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function isSupported(): boolean;
+}
+
 /**
     * @hidden
     *
@@ -1476,6 +1863,13 @@ export namespace meetingRoom {
         export {};
 }
 
+/**
+    * @hidden
+    * Hidden from Docs
+    *
+    * @internal
+    * Limited to Microsoft-internal use
+    */
 export namespace notifications {
         /**
             * @hidden
@@ -6343,6 +6737,14 @@ export namespace meeting {
                         message?: string;
                 };
         }
+        /** Defines additional sharing options which can be provided to the {@link shareAppContentToStage} API. */
+        interface IShareAppContentToStageOptions {
+                /**
+                    * The protocol option for sharing app content to the meeting stage. Defaults to `Collaborative`.
+                    * See {@link SharingProtocol} for more information.
+                    */
+                sharingProtocol?: SharingProtocol;
+        }
         /** Represents app permission to share contents to meeting. */
         interface IAppContentStageSharingCapabilities {
                 /**
@@ -6629,6 +7031,20 @@ export namespace meeting {
                     */
                 GroupCall = "groupCall"
         }
+        /**
+            * Represents the protocol option for sharing app content to the meeting stage.
+            */
+        enum SharingProtocol {
+                /**
+                    * The default protocol for sharing app content to stage. To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
+                    */
+                Collaborative = "Collaborative",
+                /**
+                    * A read-only protocol for sharing app content to stage, which uses screen sharing in meetings. If provided, this protocol will open
+                    * the specified `contentUrl` passed to the {@link shareAppContentToStage} API in a new instance and screen share that instance.
+                    */
+                ScreenShare = "ScreenShare"
+        }
         /**
             * Allows an app to get the incoming audio speaker setting for the meeting user.
             * To learn more, visit https://aka.ms/teamsjs/getIncomingClientAudioState
@@ -6756,8 +7172,10 @@ export namespace meeting {
             * `result` can either contain a true value, in case of a successful share or null when the share fails
             * @param appContentUrl - is the input URL to be shared to the meeting stage.
             * the URL origin must be included in your app manifest's `validDomains` field.
+            * @param shareOptions - is an object that contains additional sharing options. If omitted, the default
+            * sharing protocol will be `Collaborative`. See {@link IShareAppContentToStageOptions} for more information.
             */
-        function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string): void;
+        function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string, shareOptions?: IShareAppContentToStageOptions): void;
         /**
             * Allows an app to request whether the local user's app version has the required app manifest permissions to share content to meeting stage.
             * To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingCapabilities
@@ -6943,6 +7361,13 @@ export namespace meeting {
         function updateMicState(micState: MicState): void;
 }
 
+/**
+    * @hidden
+    * Hidden from Docs
+    *
+    * @internal
+    * Limited to Microsoft-internal use
+    */
 export namespace monetization {
         /**
             * @hidden
@@ -7219,6 +7644,9 @@ 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;
@@ -8226,6 +8654,130 @@ export namespace appInitialization {
         function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
 }
 
+/**
+    * Extended files API 3P storage providers, features like sending Blob from Teams to 3P app on user
+    * actions like drag and drop to compose
+    * @beta
+    */
+export namespace thirdPartyCloudStorage {
+        /**
+            * Object used to represent a file
+            * @beta
+            *
+            */
+        interface FilesFor3PStorage extends Blob {
+                /**
+                    * A number that represents the number of milliseconds since the Unix epoch
+                    */
+                lastModified: number;
+                /**
+                    * Name of the file
+                    */
+                name: string;
+                /**
+                    * file type
+                    */
+                type: string;
+                /**
+                    * A string containing the path of the file relative to the ancestor directory the user selected
+                    */
+                webkitRelativePath?: string;
+        }
+        /**
+            * File chunks an output of getDragAndDropFiles API from platform
+            * @beta
+            */
+        interface FileChunk {
+                /**
+                    * Base 64 data for the requested uri
+                    */
+                chunk: string;
+                /**
+                    * chunk sequence number
+                    */
+                chunkSequence: number;
+                /**
+                    * Indicates whether this chunk is the final segment of a file
+                    */
+                endOfFile: boolean;
+        }
+        /**
+            * Output of getDragAndDropFiles API from platform
+            * @beta
+            */
+        interface FileResult {
+                /**
+                    * Error encountered in getDragAndDropFiles API
+                    */
+                error?: SdkError;
+                /**
+                    * File chunk which will be assemebled and converted into a blob
+                    */
+                fileChunk: FileChunk;
+                /**
+                    * File index of the file for which chunk data is getting recieved
+                    */
+                fileIndex: number;
+                /**
+                    * File type/MIME type which is getting recieved
+                    */
+                fileType: string;
+                /**
+                    * Indicates whether this file is the last one in a sequence.
+                    */
+                isLastFile: boolean;
+                /**
+                    * The name of the file.
+                    */
+                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
+            */
+        interface DragAndDropFileCallback {
+                /** Callback from third party app */
+                (files: FilesFor3PStorage[], error?: SdkError): void;
+        }
+        /**
+            * Get drag-and-drop files using a callback.
+            *
+            * @param {string} dragAndDropInput - Teams thread id or Teams conversation id from a Teams chat/channel
+            * @param {DragAndDropFileCallback} dragAndDropFileCallback - callback
+            *   A callback function to handle the result of the operation
+            * @beta
+            */
+        function getDragAndDropFiles(dragAndDropInput: string, dragAndDropFileCallback: DragAndDropFileCallback): void;
+        /**
+            * Checks if the thirdPartyCloudStorage capability is supported by the host
+            * @returns boolean to represent whether the thirdPartyCloudStorage capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            * @beta
+            */
+        function isSupported(): boolean;
+}
+
 /** Execute deep link on complete function type */
 export type executeDeepLinkOnCompleteFunctionType = (status: boolean, reason?: string) => void;
 /** Callback function type */