@microsoft/teams-js 2.0.0 → 2.1.0-beta.2

package/dist/MicrosoftTeams.d.ts

@@ -645,6 +645,66 @@ export namespace files {
                     */
                 extension: string;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Actions specific to 3P cloud storage provider file and / or account
+            */
+        export enum CloudStorageProviderFileAction {
+                Download = "DOWNLOAD",
+                Upload = "UPLOAD",
+                Delete = "DELETE"
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Interface for 3P cloud storage provider request content type
+            */
+        export interface CloudStorageProviderRequest<T> {
+                content: T;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Base interface for 3P cloud storage provider action request content
+            */
+        export interface CloudStorageProviderContent {
+                providerCode: CloudStorageProvider;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Interface representing 3P cloud storage provider add new file action.
+            * The file extension represents type of file e.g. docx, pptx etc. and need not be prefixed with dot(.)
+            */
+        export interface CloudStorageProviderNewFileContent extends CloudStorageProviderContent {
+                newFileName: string;
+                newFileExtension: string;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Interface representing 3P cloud storage provider rename existing file action
+            */
+        export interface CloudStorageProviderRenameFileContent extends CloudStorageProviderContent {
+                existingFile: CloudStorageFolderItem | ISharePointFile;
+                newFile: CloudStorageFolderItem | ISharePointFile;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Interface representing 3P cloud storage provider actions like Upload / Download / Delete file(s)
+            */
+        export interface CloudStorageProviderActionContent extends CloudStorageProviderContent {
+                action: CloudStorageProviderFileAction;
+                itemList: CloudStorageFolderItem[] | ISharePointFile[];
+        }
         /**
             * @hidden
             * Hide from docs
@@ -732,6 +792,85 @@ export namespace files {
             * @param callback Callback that will be triggered post open download folder/path
             */
         export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * 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
+            *
+            * @param callback Callback that will be triggered post add 3P cloud storage provider action
+            */
+        export function addCloudStorageProvider(callback: (error?: SdkError) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Initiates signout of 3P cloud storage provider flow, which will remove the selected
+            * 3P cloud storage provider from the list of added providers. No other user input and / or action
+            * is required except the 3P cloud storage provider to signout from
+            *
+            * @param logoutRequest 3P cloud storage provider remove action request content
+            * @param callback Callback that will be triggered post signout of 3P cloud storage provider action
+            */
+        export function removeCloudStorageProvider(logoutRequest: CloudStorageProviderRequest<CloudStorageProviderContent>, callback: (error?: SdkError) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Initiates the add 3P cloud storage file flow, which will add a new file for the given 3P provider
+            *
+            * @param addNewFileRequest 3P cloud storage provider add action request content
+            * @param callback Callback that will be triggered post adding a new file flow is finished
+            */
+        export function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Initiates the rename 3P cloud storage file flow, which will rename an existing file in the given 3P provider
+            *
+            * @param renameFileRequest 3P cloud storage provider rename action request content
+            * @param callback Callback that will be triggered post renaming an existing file flow is finished
+            */
+        export function renameCloudStorageProviderFile(renameFileRequest: CloudStorageProviderRequest<CloudStorageProviderRenameFileContent>, callback: (error?: SdkError) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Initiates the 3P cloud storage provider file action (Upload / Download / Delete) flow
+            *
+            * Upload Action : Allows uploading file(s) to the given 3P cloud storage provider
+            * Download Action : Allows downloading file(s) from the given 3P cloud storage provider
+            * Delete Action : Allows deleting file(s) from the given 3P cloud storage provider
+            *
+            * @param cloudStorageProviderFileActionRequest 3P cloud storage provider file action (Upload / Download / Delete) request content
+            * @param callback Callback that will be triggered post 3P cloud storage action
+            */
+        export function performCloudStorageProviderFileAction(cloudStorageProviderFileActionRequest: CloudStorageProviderRequest<CloudStorageProviderActionContent>, callback: (error?: SdkError) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Register a handler to be called when a user's 3P cloud storage provider list changes i.e.
+            * post adding / removing a 3P provider, list is updated
+            *
+            * @param handler - When 3P cloud storage provider list is updated this handler is called
+            *
+            */
+        export function registerCloudStorageProviderListChangeHandler(handler: () => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Register a handler to be called when a user's 3P cloud storage provider content changes i.e.
+            * when file(s) is/are added / renamed / deleted / uploaded, the list of files is updated
+            *
+            * @param handler - When 3P cloud storage provider content is updated this handler is called
+            *
+            */
+        export function registerCloudStorageProviderContentChangeHandler(handler: () => void): void;
         export {};
 }
 
@@ -2174,6 +2313,9 @@ export interface BotUrlDialogInfo extends UrlDialogInfo {
             */
         completionBotId: string;
 }
+/**
+    * Data structure to describe dialog information
+    */
 export interface DialogInfo {
         /**
             * The url to be rendered in the webview/iframe.
@@ -4152,6 +4294,57 @@ export namespace meeting {
                     */
                 isSpeakingDetected: boolean;
         }
+        /**
+            * Property bag for the meeting reaction received event
+            *
+            * @beta
+            */
+        interface MeetingReactionReceivedEventData {
+                /**
+                    * Indicates the type of meeting reaction received
+                    */
+                meetingReactionType?: MeetingReactionType;
+                /**
+                    * error object in case there is a failure
+                    */
+                error?: SdkError;
+        }
+        /**
+            * Interface for raiseHandState properties
+            *
+            * @beta
+            */
+        interface IRaiseHandState {
+                /** Indicates whether the selfParticipant's hand is raised or not*/
+                isHandRaised: boolean;
+        }
+        /**
+            * Property bag for the raiseHandState changed event
+            *
+            * @beta
+            */
+        interface RaiseHandStateChangedEventData {
+                /**
+                    * entire raiseHandState object for the selfParticipant
+                    */
+                raiseHandState: IRaiseHandState;
+                /**
+                    * error object in case there is a failure
+                    */
+                error?: SdkError;
+        }
+        /**
+            * Different types of meeting reactions that can be sent/received
+            *
+            * @beta
+            */
+        enum MeetingReactionType {
+                like = "like",
+                heart = "heart",
+                laugh = "laugh",
+                surprised = "surprised",
+                applause = "applause"
+        }
         enum MeetingType {
                 Unknown = "Unknown",
                 Adhoc = "Adhoc",
@@ -4289,6 +4482,26 @@ export namespace meeting {
             * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
             */
         function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
+        /**
+            * Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
+            * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
+            * that will have the raiseHandState or an error object. Only one handler can be registered at a time. A subsequent registration
+            * replaces an existing registration.
+            *
+            * @param handler The handler to invoke when the selfParticipant's (current user's) raiseHandState changes.
+            *
+            * @beta
+            */
+        function registerRaiseHandStateChangedHandler(handler: (eventData: RaiseHandStateChangedEventData) => void): void;
+        /**
+            * Registers a handler for receiving meeting reactions. When the selfParticipant (current user) successfully sends a meeting reaction and it is being rendered on the UI, the meetingReactionType will be populated. Only one handler can be registered
+            * at a time. A subsequent registration replaces an existing registration.
+            *
+            * @param handler The handler to invoke when the selfParticipant (current user) successfully sends a meeting reaction
+            *
+            * @beta
+            */
+        function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
 }
 
 export namespace monetization {
@@ -4499,6 +4712,94 @@ export namespace people {
         function isSupported(): boolean;
 }
 
+/**
+    * Namespace for profile related APIs.
+    *
+    * @beta
+    */
+export namespace profile {
+        /**
+            * Opens a profile card at a specified position to show profile information about a persona.
+            * @param showProfileRequest The parameters to position the card and identify the target user.
+            * @returns Promise that will be fulfilled when the operation has completed
+            */
+        function showProfile(showProfileRequest: ShowProfileRequest): Promise<void>;
+        /**
+            * The type of modalities that are supported when showing a profile.
+            * Can be provided as an optional hint with the request and will be
+            * respected if the hosting M365 application supports it.
+            */
+        type Modality = 'Card' | 'Expanded';
+        /**
+            * The type of the profile trigger.
+            *  - MouseHover: The user hovered a target.
+            *  - MouseClick: The user clicked a target.
+            *  - KeyboardPress: The user initiated the show profile request with their keyboard.
+            *  - AppRequest: The show profile request is happening programmatically, without direct user interaction.
+            */
+        type TriggerType = 'MouseHover' | 'MouseClick' | 'KeyboardPress' | 'AppRequest';
+        /**
+            * The set of identifiers that are supported for resolving the persona.
+            *
+            * At least one is required, and if multiple are provided then only the highest
+            * priority one will be used (AadObjectId > Upn > Smtp).
+            */
+        type PersonaIdentifiers = {
+                /**
+                    * The object id in Azure Active Directory.
+                    *
+                    * This id is guaranteed to be unique for an object within a tenant,
+                    * and so if provided will lead to a more performant lookup. It can
+                    * be resolved via MS Graph (see https://docs.microsoft.com/en-us/graph/api/resources/users
+                    * for examples).
+                    */
+                readonly AadObjectId?: string;
+                /**
+                    * The primary SMTP address.
+                    */
+                readonly Smtp?: string;
+                /**
+                    * The user principle name.
+                    */
+                readonly Upn?: string;
+        };
+        /**
+            * The persona to show the profile for.
+            */
+        interface Persona {
+                /**
+                    * The set of identifiers that are supported for resolving the persona.
+                    */
+                identifiers: PersonaIdentifiers;
+                /**
+                    * Optional display name override. If not specified the user's display name will be resolved normally.
+                    */
+                displayName?: string;
+        }
+        /**
+            * Input parameters provided to the showProfile API.
+            */
+        interface ShowProfileRequest {
+                /**
+                    * An optional hint to the hosting M365 application about which modality of the profile you want to show.
+                    */
+                modality?: Modality;
+                /**
+                    * The information about the persona to show the profile for.
+                    */
+                persona: Persona;
+                /**
+                    * The bounding rectangle of the target.
+                    */
+                targetElementBoundingRect: DOMRect;
+                /**
+                    * Specifies which user interaction was used to trigger the API call.
+                    */
+                triggerType: TriggerType;
+        }
+        function isSupported(): boolean;
+}
+
 /**
     * Namespace to video extensibility of the SDK
     */
@@ -4691,26 +4992,40 @@ export namespace stageView {
 }
 
 export namespace call {
-    enum CallModalities {
-        Unknown = "unknown",
-        Audio = "audio",
-        Video = "video",
-        VideoBasedScreenSharing = "videoBasedScreenSharing",
-        Data = "data"
-    }
-    interface StartCallParams {
-        targets: string[];
-        requestedModalities?: CallModalities[];
-        source?: string;
-    }
-    /**
-      * Starts a call with other users
-      *
-      * @param startCallParams - Parameters for the call
-      * @returns If the call is accepted
-      */
-    function startCall(startCallParams: StartCallParams): Promise<boolean>;
-    function isSupported(): boolean;
+        enum CallModalities {
+                Unknown = "unknown",
+                Audio = "audio",
+                Video = "video",
+                VideoBasedScreenSharing = "videoBasedScreenSharing",
+                Data = "data"
+        }
+        interface StartCallParams {
+                /**
+                    * Comma-separated list of user IDs representing the participants of the call.
+                    *
+                    * @remarks
+                    * Currently the User ID field supports the Azure AD UserPrincipalName,
+                    * typically an email address, or in case of a PSTN call, it supports a pstn
+                    * mri 4:<phonenumber>.
+                    */
+                targets: string[];
+                /**
+                    * List of modalities for the call. Defaults to [“audio”].
+                    */
+                requestedModalities?: CallModalities[];
+                /**
+                    * An optional parameter that informs about the source of the deep link
+                    */
+                source?: string;
+        }
+        /**
+            * Starts a call with other users
+            *
+            * @param startCallParams - Parameters for the call
+            * @returns If the call is accepted
+            */
+        function startCall(startCallParams: StartCallParams): Promise<boolean>;
+        function isSupported(): boolean;
 }
 
 /**
@@ -5089,7 +5404,7 @@ export namespace settings {
         function setValidityState(validityState: boolean): void;
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
+            * As of 2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
             *
             * Gets the settings for the current instance.
             *
@@ -5143,9 +5458,8 @@ export namespace settings {
 export namespace tasks {
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
-            * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
-            *
+            * As of 2.0.0, please use {@link dialog.open dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
+            * and {@link dialog.bot.open dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot based dialogs.
             * Allows an app to open the task module.
             *
             * @param taskInfo - An object containing the parameters of the task module
@@ -5163,7 +5477,7 @@ export namespace tasks {
         function updateTask(taskInfo: TaskInfo): void;
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
+            * As of 2.0.0, please use {@link dialog.submit} instead.
             *
             * Submit the task module.
             *
@@ -5171,8 +5485,24 @@ export namespace tasks {
             * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
             */
         function submitTask(result?: string | object, appIds?: string | string[]): void;
+        /**
+            * Converts {@link TaskInfo} to {@link UrlDialogInfo}
+            * @param taskInfo - TaskInfo object to convert
+            * @returns - Converted UrlDialogInfo object
+            */
         function getUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): UrlDialogInfo;
+        /**
+            * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
+            * @param taskInfo - TaskInfo object to convert
+            * @returns - converted BotUrlDialogInfo object
+            */
         function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
+        /**
+            * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
+            * otherwise uses the height and width values corresponding to {@link TaskModuleDimension.Small}
+            * @param taskInfo TaskInfo object from which to extract size info, if specified
+            * @returns TaskInfo with height and width specified
+            */
         function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
 }