@microsoft/teams-js 2.0.0-beta.4-dev.19 → 2.0.0-beta.4-dev.22

package/dist/MicrosoftTeams.d.ts

@@ -1,94 +1,5 @@
 // Generated by dts-bundle v0.7.3
 
-/**
-    * @hidden
-    * Namespace to interact with bots using the SDK.
-    *
-    * @alpha
-    */
-export namespace bot {
-        /**
-            * @hidden
-            * Hide from docs until release.
-            * ------
-            * Sends query to bot in order to retrieve data.
-            *
-            * @param botRequest - query to send to bot.
-            * @param onSuccess - callback to invoke when data is retrieved from bot
-            * @param onError - callback to invoke should an error occur
-            */
-        export function sendQuery(botRequest: QueryRequest, onSuccess?: (data: QueryResponse) => void, onError?: (error: string) => void): void;
-        /**
-            * @hidden
-            * Hide from docs until release.
-            * -----
-            * Retrieves list of support commands from bot
-            *
-            * @param onSuccess - callback to invoke when data is retrieved from bot
-            * @param onError - callback to invoke should an error occur
-            */
-        export function getSupportedCommands(onSuccess?: (response: Command[]) => void, onError?: (error: string) => void): void;
-        /**
-            * @hidden
-            * Hide from docs until release.
-            * -----
-            * Authenticates a user for json tab
-            *
-            * @param authRequest - callback to invoke when data is retrieved from bot
-            * @param onSuccess - callback to invoke when user is authenticated
-            * @param onError - callback to invoke should an error occur
-            */
-        export function authenticate(authRequest: AuthQueryRequest, onSuccess?: (results: Results) => void, onError?: (error: string) => void): void;
-        export interface QueryRequest {
-                /**
-                    * @hidden
-                    * Query to search for
-                    */
-                query: string;
-                commandId?: string;
-                option?: {
-                        skip: number;
-                        count: number;
-                };
-        }
-        export interface Results {
-                attachments: Attachment[];
-                layout: any;
-                botId: string;
-        }
-        export interface Auth {
-                url: string;
-                title: string;
-        }
-        export type ResponseType = 'Results' | 'Auth';
-        interface Response<T extends ResponseType> {
-                type: T;
-        }
-        export interface ResultResponse extends Response<'Results'> {
-                data: Results;
-        }
-        export interface AuthResponse extends Response<'Auth'> {
-                data: Auth;
-        }
-        export type QueryResponse = ResultResponse | AuthResponse;
-        export interface AuthQueryRequest extends QueryRequest {
-                url: string;
-        }
-        export interface Attachment {
-                card: any;
-                previewCard: any;
-                previewRawPayload: any;
-                rawPayload: any;
-        }
-        export interface Command {
-                title: string;
-                id: string;
-                initialRun: boolean;
-        }
-        export function isSupported(): boolean;
-        export {};
-}
-
 /**
     * @hidden
     * Namespace to interact with the logging part of the SDK.
@@ -351,50 +262,6 @@ export function registerCustomHandler(actionName: string, customHandler: (...arg
     */
 export function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
 
-/**
-    *
-    * @internal
-    */
-interface OpenChatRequest {
-        /**
-            * @hidden
-            * The message to send when opening chat
-            */
-        message?: string;
-}
-/**
-    * @hidden
-    * Hide from docs.
-    * ------
-    *
-    * @internal
-    */
-export interface OpenSingleChatRequest extends OpenChatRequest {
-        /**
-            * @hidden
-            * User's UPN to open chat with
-            */
-        user: string;
-}
-/**
-    * @hidden
-    * Hide from docs.
-    * ------
-    *
-    * @internal
-    */
-export interface OpenGroupChatRequest extends OpenChatRequest {
-        /**
-            * @hidden
-            * Array containing UPNs of users to open chat with
-            */
-        users: string[];
-        /**
-            * @hidden
-            * The display name of a conversation for 3 or more users
-            */
-        topic?: string;
-}
 /**
     * @hidden
     * Hide from docs.
@@ -474,32 +341,23 @@ export interface ConversationResponse {
     *
     * @alpha
     */
-export namespace chat {
+export namespace conversation {
         /**
             * @hidden
             * Hide from docs
             * --------------
-            * Allows the user to open a chat with a single user and allows
-            * for the user to specify the message they wish to send.
-            *
-            *@param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
+            * Allows the user to start or continue a conversation with each subentity inside the tab
             *
             * @returns Promise resolved upon completion
             */
-        function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
+        function openConversation(openConversationRequest: OpenConversationRequest): Promise<void>;
         /**
             * @hidden
             * Hide from docs
             * --------------
-            * Allows the user to create a chat with multiple users (2+) and allows
-            * for the user to specify a message and name the topic of the conversation. If
-            * only 1 user is provided into users array default back to origin openChat.
-            *
-            * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
-            *
-            * @returns Promise resolved upon completion
+            * Allows the user to close the conversation in the right pane
             */
-        function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
+        function closeConversation(): void;
         /**
             * @hidden
             * Hide from docs
@@ -514,27 +372,7 @@ export namespace chat {
             */
         function getChatMembers(): Promise<ChatMembersInformation>;
         function isSupported(): boolean;
-        namespace conversation {
-                /**
-                    * @hidden
-                    * Hide from docs
-                    * --------------
-                    * Allows the user to start or continue a conversation with each subentity inside the tab
-                    *
-                    * @returns Promise resolved upon completion
-                    */
-                function openConversation(openConversationRequest: OpenConversationRequest): Promise<void>;
-                /**
-                    * @hidden
-                    * Hide from docs
-                    * --------------
-                    * Allows the user to close the conversation in the right pane
-                    */
-                function closeConversation(): void;
-                function isSupported(): boolean;
-        }
 }
-export {};
 
 /**
     * @hidden
@@ -911,10 +749,12 @@ export namespace files {
         /**
             * @hidden
             * Hide from docs
-            * ------
-            * Open download preference folder
+            *
+            * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
+            * @param fileObjectId Id of the file whose containing folder should be opened
+            * @param callback Callback that will be triggered post open download folder/path
             */
-        export function openDownloadFolder(): void;
+        export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;
         export {};
 }
 
@@ -923,16 +763,19 @@ export namespace files {
     */
 export namespace legacy {
         namespace fullTrust {
-                /**
-                    * @hidden
-                    * Hide from docs
-                    * ------
-                    * Allows an app to retrieve information of all user joined teams
-                    *
-                    * @param teamInstanceParameters - OPTIONAL Flags that specify whether to scope call to favorite teams
-                    * @returns Promise resolved containing information about the user joined teams or rejected with error
-                    */
-                function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
+                namespace joinedTeams {
+                        /**
+                            * @hidden
+                            * Hide from docs
+                            * ------
+                            * Allows an app to retrieve information of all user joined teams
+                            *
+                            * @param teamInstanceParameters - OPTIONAL Flags that specify whether to scope call to favorite teams
+                            * @returns Promise resolved containing information about the user joined teams or rejected with error
+                            */
+                        function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
+                        function isSupported(): boolean;
+                }
                 /**
                     * @hidden
                     * Hide from docs
@@ -995,7 +838,7 @@ export namespace meetingRoom {
             * ------
             * Types of Stage Layout control capabilities of a meeting room.
             */
-        type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
+        type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
         /**
             * @hidden
             * Hide from docs
@@ -2122,8 +1965,8 @@ export interface Context {
         hostName?: HostName;
         /**
             * @hidden
-            * The type of the host client. Possible values are : android, ios, web, desktop, rigel (deprecated, use teamsRoomsWindows instead),
-            * teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
+            * The type of the host client. Possible values are : android, ios, web, desktop, rigel(deprecated, use teamsRoomsWindows instead),
+            * surfaceHub, teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
             */
         hostClientType?: HostClientType;
         /**
@@ -2254,6 +2097,9 @@ export interface DeepLinkParameters {
             */
         subEntityWebUrl?: string;
 }
+/**
+    * Data structure to represent the size of a dialog
+    */
 export interface DialogSize {
         /**
             * The requested height of the webview/iframe.
@@ -2264,6 +2110,9 @@ export interface DialogSize {
             */
         width: DialogDimension | number;
 }
+/**
+    * Data structure to describe dialog information needed to open a url based dialog.
+    */
 export interface UrlDialogInfo {
         /**
             * The url to be rendered in the webview/iframe.
@@ -2279,6 +2128,9 @@ export interface UrlDialogInfo {
             */
         fallbackUrl?: string;
 }
+/**
+    * Data structure to describe dialog information needed to open a bot based dialog.
+    */
 export interface BotUrlDialogInfo extends UrlDialogInfo {
         /**
             * Specifies a bot ID to send the result of the user's interaction with the task module.
@@ -2851,25 +2703,105 @@ export namespace appInstallDialog {
 }
 
 /**
-    * Namespace to interact with the dialog module-specific part of the SDK.
+    * Describes information needed to start a chat
     *
-    * @remarks
-    * This object is usable only on the content frame.
+    * @beta
+    */
+interface OpenChatRequest {
+        /**
+            * An optional message used when initiating chat
+            */
+        message?: string;
+}
+/**
+    * Used when starting a chat with one person
+    *
+    * @see OpenGroupChatRequest for use when a chat with more than one person
     *
     * @beta
     */
-export interface SdkResponse {
-        err?: string;
-        result?: string | object;
+export interface OpenSingleChatRequest extends OpenChatRequest {
+        /**
+            * The Azure Active Directory UPN (e-mail address) of the user to chat with
+            */
+        user: string;
+}
+/**
+    * Used when starting a chat with more than one person
+    *
+    * @see OpenSingleChatRequest for use in a chat with only one person
+    *
+    * @beta
+    */
+export interface OpenGroupChatRequest extends OpenChatRequest {
+        /**
+            * Array containing Azure Active Directory UPNs (e-mail addresss) of users to open chat with
+            */
+        users: string[];
+        /**
+            * The display name of a conversation for 3 or more users (chats with fewer than three users will ignore this field)
+            */
+        topic?: string;
+}
+/**
+    * Contains functionality to start chat with others
+    *
+    * @beta
+    */
+export namespace chat {
+        /**
+            * Allows the user to open a chat with a single user and allows
+            * for the user to specify the message they wish to send.
+            *
+            * @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
+            *
+            * @returns Promise resolved upon completion
+            */
+        function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
+        /**
+            * Allows the user to create a chat with multiple users (2+) and allows
+            * for the user to specify a message and name the topic of the conversation. If
+            * only 1 user is provided into users array default back to origin openChat.
+            *
+            * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
+            *
+            * @returns Promise resolved upon completion
+            */
+        function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
+        function isSupported(): boolean;
 }
+export {};
+
+/**
+    * Namespace to interact with the dialog module-specific part of the SDK.
+    *
+    * @beta
+    */
 export namespace dialog {
+        /**
+            * Data Structure to represent the SDK response when dialog closes
+            */
+        interface ISdkResponse {
+                /**
+                    * Error in case there is a failure before dialog submission
+                    */
+                err?: string;
+                /**
+                    * Result value that the dialog is submitted with using {@linkcode submit} function
+                    *
+                    */
+                result?: string | object;
+        }
         type PostMessageChannel = (message: any) => void;
-        type DialogSubmitHandler = (result: SdkResponse) => void;
+        type DialogSubmitHandler = (result: ISdkResponse) => void;
         /**
-            * Allows an app to open the dialog module.
+            * Allows app to open a url based dialog.
+            *
+            * @remarks
+            * This function cannot be called from inside of a dialog
             *
             * @param urlDialogInfo - An object containing the parameters of the dialog module.
-            * @param submitHandler - This Handler is called when the dialog has been submitted or closed.
+            * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
             * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
             *
             * @returns a function that can be used to send messages to the dialog.
@@ -2878,24 +2810,37 @@ export namespace dialog {
         /**
             * Submit the dialog module.
             *
-            * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
+            * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
             * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
             */
         function submit(result?: string | object, appIds?: string | string[]): void;
         /**
             *  Send message to the parent from dialog
             *
-            * @param message - The message to send
+            *  @remarks
+            * This function is only called from inside of a dialog
+            *
+            * @param message - The message to send to the parent
             */
         function sendMessageToParentFromDialog(message: any): void;
         /**
-            * Fucntion to call when an event is received from the Parent
+            * Register a listener that will be triggered when a message is received from the app that opened the dialog.
             *
-            * @param type - The event to listen to. Currently the only supported type is 'message'.
-            * @param listener - listener - The listener that will be called.
+            * @remarks
+            * This function is only called from inside of a dialog.
+            *
+            * @param listener - The listener that will be triggered.
+            */
+        function registerOnMessageFromParent(listener: PostMessageChannel): void;
+        /**
+            * Checks if dialog module is supported by the host
+            *
+            * @returns boolean to represent whether dialog module is supported
             */
-        function registerOnMessageFromParent(listener: (message: any) => void): void;
         function isSupported(): boolean;
+        /**
+            * Namespace to update the dialog
+            */
         namespace update {
                 /**
                     * Update dimensions - height/width of a dialog.
@@ -2903,10 +2848,32 @@ export namespace dialog {
                     * @param dimensions - An object containing width and height properties.
                     */
                 function resize(dimensions: DialogSize): void;
+                /**
+                    * Checks if dialog.update capability is supported by the host
+                    *
+                    * @returns boolean to represent whether dialog.update is supported
+                    */
                 function isSupported(): boolean;
         }
+        /**
+            * Namespace to open a dialog that sends results to the bot framework
+            */
         namespace bot {
+                /**
+                    * Allows an app to open the dialog module using bot.
+                    *
+                    * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
+                    * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
+                    * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
+                    *
+                    * @returns a function that can be used to send messages to the dialog.
+                    */
                 function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel;
+                /**
+                    * Checks if dialog.bot capability is supported by the host
+                    *
+                    * @returns boolean to represent whether dialog.bot is supported
+                    */
                 function isSupported(): boolean;
         }
 }
@@ -4047,6 +4014,13 @@ export namespace meeting {
                     */
                 isAppSharing: boolean;
         }
+        interface ISpeakingState {
+                /**
+                    * Indicates whether one or more participants in a meeting are speaking, or
+                    * if no participants are speaking
+                    */
+                isSpeakingDetected: boolean;
+        }
         interface IAppContentStageSharingCapabilities {
                 /**
                     * indicates whether app has permission to share contents to meeting stage
@@ -4301,6 +4275,13 @@ export namespace meeting {
             * (indication of successful retrieval), or null (indication of failed retrieval)
             */
         function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
+        /**
+            * Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
+            * will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
+            * at a time. A subsequent registration replaces an existing registration.
+            * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
+            */
+        function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
 }
 
 /**
@@ -5172,7 +5153,8 @@ export namespace settings {
 export namespace tasks {
         /**
             * @deprecated
-            * As of 2.0.0-beta.4, please use {@link dialog.open(dialogInfo: DialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} instead.
+            * As of 2.0.0-beta.4, 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.
             *
             * Allows an app to open the task module.
             *