@microsoft/teams-js 2.0.0-beta.4-dev.17 → 2.0.0-beta.4-dev.18

package/dist/MicrosoftTeams.d.ts

@@ -351,6 +351,123 @@ 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.
+    * ------
+    *
+    * @internal
+    */
+export interface OpenConversationRequest {
+        /**
+            * @hidden
+            * The Id of the subEntity where the conversation is taking place
+            */
+        subEntityId: string;
+        /**
+            * @hidden
+            * The title of the conversation
+            */
+        title: string;
+        /**
+            * @hidden
+            * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
+            */
+        conversationId?: string;
+        /**
+            * @hidden
+            * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
+            */
+        channelId?: string;
+        /**
+            * @hidden
+            * The entity Id of the tab
+            */
+        entityId: string;
+        /**
+            * @hidden
+            * A function that is called once the conversation Id has been created
+            */
+        onStartConversation?: (conversationResponse: ConversationResponse) => void;
+        /**
+            * @hidden
+            * A function that is called if the pane is closed
+            */
+        onCloseConversation?: (conversationResponse: ConversationResponse) => void;
+}
+/**
+    * @hidden
+    * Hide from docs.
+    * ------
+    *
+    * @internal
+    */
+export interface ConversationResponse {
+        /**
+            * @hidden
+            * The Id of the subEntity where the conversation is taking place
+            */
+        subEntityId: string;
+        /**
+            * @hidden
+            * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
+            */
+        conversationId?: string;
+        /**
+            * @hidden
+            * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
+            */
+        channelId?: string;
+        /**
+            * @hidden
+            * The entity Id of the tab
+            */
+        entityId?: string;
+}
 /**
     * @hidden
     * Namespace to interact with the conversational subEntities inside the tab
@@ -362,34 +479,62 @@ export namespace chat {
             * @hidden
             * Hide from docs
             * --------------
-            * Allows the user to start or continue a conversation with each subentity inside the tab
+            * 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 openConversation(openConversationRequest: OpenConversationRequest): Promise<void>;
+        function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
         /**
             * @hidden
             * Hide from docs
             * --------------
-            * Allows the user to close the conversation in the right pane
+            * 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 closeConversation(): void;
+        function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
         /**
             * @hidden
             * Hide from docs
             * ------
-            * Allows an app to retrieve information of all chat members
-            * Because a malicious party run your content in a browser, this value should
-            * be used only as a hint as to who the members are and never as proof of membership.
+            * Allows retrieval of information for all chat members.
+            * NOTE: This value should be used only as a hint as to who the members are
+            * and never as proof of membership in case your app is being hosted by a malicious party.
             *
-            * @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
             * @returns Promise resolved with information on all chat members
             *
             * @internal
             */
         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
@@ -2183,79 +2328,6 @@ export interface DialogSize {
         height: DialogDimension | number;
         width: DialogDimension | number;
 }
-/**
-    * @hidden
-    * Hide from docs.
-    * ------
-    *
-    * @internal
-    */
-export interface OpenConversationRequest {
-        /**
-            * @hidden
-            * The Id of the subEntity where the conversation is taking place
-            */
-        subEntityId: string;
-        /**
-            * @hidden
-            * The title of the conversation
-            */
-        title: string;
-        /**
-            * @hidden
-            * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
-            */
-        conversationId?: string;
-        /**
-            * @hidden
-            * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
-            */
-        channelId?: string;
-        /**
-            * @hidden
-            * The entity Id of the tab
-            */
-        entityId: string;
-        /**
-            * @hidden
-            * A function that is called once the conversation Id has been created
-            */
-        onStartConversation?: (conversationResponse: ConversationResponse) => void;
-        /**
-            * @hidden
-            * A function that is called if the pane is closed
-            */
-        onCloseConversation?: (conversationResponse: ConversationResponse) => void;
-}
-/**
-    * @hidden
-    * Hide from docs.
-    * ------
-    *
-    * @internal
-    */
-export interface ConversationResponse {
-        /**
-            * @hidden
-            * The Id of the subEntity where the conversation is taking place
-            */
-        subEntityId: string;
-        /**
-            * @hidden
-            * The Id of the conversation. This is optional and should be specified whenever a previous conversation about a specific sub-entity has already been started before
-            */
-        conversationId?: string;
-        /**
-            * @hidden
-            * The Id of the channel. This is optional and should be specified whenever a conversation is started or opened in a personal app scope
-            */
-        channelId?: string;
-        /**
-            * @hidden
-            * The entity Id of the tab
-            */
-        entityId?: string;
-}
 /**
     * @hidden
     * Hide from docs.

package/dist/MicrosoftTeams.js

@@ -1121,7 +1121,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.4-dev.17";
+var version = "2.0.0-beta.4-dev.18";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1819,7 +1819,9 @@ var runtime = {
         bot: undefined,
         calendar: undefined,
         call: undefined,
-        chat: undefined,
+        chat: {
+            conversation: undefined,
+        },
         dialog: {
             bot: undefined,
             update: undefined,
@@ -1858,7 +1860,9 @@ var teamsRuntimeConfig = {
         appEntity: {},
         bot: {},
         call: {},
-        chat: {},
+        chat: {
+            conversation: {},
+        },
         dialog: {
             bot: {},
             update: {},
@@ -4149,66 +4153,68 @@ var chat;
      * @hidden
      * Hide from docs
      * --------------
-     * Allows the user to start or continue a conversation with each subentity inside the tab
+     * 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 openConversation(openConversationRequest) {
+    function openChat(openChatRequest) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
-            var sendPromise = sendAndHandleStatusAndReason('conversations.openConversation', {
-                title: openConversationRequest.title,
-                subEntityId: openConversationRequest.subEntityId,
-                conversationId: openConversationRequest.conversationId,
-                channelId: openConversationRequest.channelId,
-                entityId: openConversationRequest.entityId,
+            var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
+                members: openChatRequest.user,
+                message: openChatRequest.message,
             });
-            if (openConversationRequest.onStartConversation) {
-                registerHandler('startConversation', function (subEntityId, conversationId, channelId, entityId) {
-                    return openConversationRequest.onStartConversation({
-                        subEntityId: subEntityId,
-                        conversationId: conversationId,
-                        channelId: channelId,
-                        entityId: entityId,
-                    });
-                });
-            }
-            if (openConversationRequest.onCloseConversation) {
-                registerHandler('closeConversation', function (subEntityId, conversationId, channelId, entityId) {
-                    return openConversationRequest.onCloseConversation({
-                        subEntityId: subEntityId,
-                        conversationId: conversationId,
-                        channelId: channelId,
-                        entityId: entityId,
-                    });
-                });
-            }
             resolve(sendPromise);
         });
     }
-    chat.openConversation = openConversation;
+    chat.openChat = openChat;
     /**
      * @hidden
      * Hide from docs
      * --------------
-     * Allows the user to close the conversation in the right pane
+     * 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 closeConversation() {
-        ensureInitialized(FrameContexts.content);
-        sendMessageToParent('conversations.closeConversation');
-        removeHandler('startConversation');
-        removeHandler('closeConversation');
+    function openGroupChat(openChatRequest) {
+        return new Promise(function (resolve) {
+            if (openChatRequest.users.length < 1) {
+                throw Error('OpenGroupChat Failed: No users specified');
+            }
+            if (openChatRequest.users.length === 1) {
+                var chatRequest = {
+                    user: openChatRequest.users[0],
+                    message: openChatRequest.message,
+                };
+                openChat(chatRequest);
+            }
+            else {
+                ensureInitialized(FrameContexts.content);
+                var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
+                    members: openChatRequest.users,
+                    message: openChatRequest.message,
+                    topic: openChatRequest.topic,
+                });
+                resolve(sendPromise);
+            }
+        });
     }
-    chat.closeConversation = closeConversation;
+    chat.openGroupChat = openGroupChat;
     /**
      * @hidden
      * Hide from docs
      * ------
-     * Allows an app to retrieve information of all chat members
-     * Because a malicious party run your content in a browser, this value should
-     * be used only as a hint as to who the members are and never as proof of membership.
+     * Allows retrieval of information for all chat members.
+     * NOTE: This value should be used only as a hint as to who the members are
+     * and never as proof of membership in case your app is being hosted by a malicious party.
      *
-     * @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
      * @returns Promise resolved with information on all chat members
      *
      * @internal
@@ -4224,6 +4230,68 @@ var chat;
         return runtime.supports.chat ? true : false;
     }
     chat.isSupported = isSupported;
+    var conversation;
+    (function (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) {
+            return new Promise(function (resolve) {
+                ensureInitialized(FrameContexts.content);
+                var sendPromise = sendAndHandleStatusAndReason('conversations.openConversation', {
+                    title: openConversationRequest.title,
+                    subEntityId: openConversationRequest.subEntityId,
+                    conversationId: openConversationRequest.conversationId,
+                    channelId: openConversationRequest.channelId,
+                    entityId: openConversationRequest.entityId,
+                });
+                if (openConversationRequest.onStartConversation) {
+                    registerHandler('startConversation', function (subEntityId, conversationId, channelId, entityId) {
+                        return openConversationRequest.onStartConversation({
+                            subEntityId: subEntityId,
+                            conversationId: conversationId,
+                            channelId: channelId,
+                            entityId: entityId,
+                        });
+                    });
+                }
+                if (openConversationRequest.onCloseConversation) {
+                    registerHandler('closeConversation', function (subEntityId, conversationId, channelId, entityId) {
+                        return openConversationRequest.onCloseConversation({
+                            subEntityId: subEntityId,
+                            conversationId: conversationId,
+                            channelId: channelId,
+                            entityId: entityId,
+                        });
+                    });
+                }
+                resolve(sendPromise);
+            });
+        }
+        conversation.openConversation = openConversation;
+        /**
+         * @hidden
+         * Hide from docs
+         * --------------
+         * Allows the user to close the conversation in the right pane
+         */
+        function closeConversation() {
+            ensureInitialized(FrameContexts.content);
+            sendMessageToParent('conversations.closeConversation');
+            removeHandler('startConversation');
+            removeHandler('closeConversation');
+        }
+        conversation.closeConversation = closeConversation;
+        function isSupported() {
+            return runtime.supports.chat.conversation ? true : false;
+        }
+        conversation.isSupported = isSupported;
+    })(conversation = chat.conversation || (chat.conversation = {}));
 })(chat || (chat = {}));
 
 ;// CONCATENATED MODULE: ./src/public/appInstallDialog.ts