@microsoft/teams-js 2.0.0-beta.4-dev.21 → 2.0.0-beta.4-dev.24

package/dist/MicrosoftTeams.d.ts

@@ -2703,72 +2703,62 @@ export namespace appInstallDialog {
 }
 
 /**
+    * Describes information needed to start a chat
     *
-    * @internal
+    * @beta
     */
 interface OpenChatRequest {
         /**
-            * @hidden
-            * The message to send when opening chat
+            * An optional message used when initiating chat
             */
         message?: string;
 }
 /**
-    * @hidden
-    * Hide from docs.
-    * ------
+    * Used when starting a chat with one person
     *
-    * @internal
+    * @see OpenGroupChatRequest for use when a chat with more than one person
+    *
+    * @beta
     */
 export interface OpenSingleChatRequest extends OpenChatRequest {
         /**
-            * @hidden
-            * User's UPN to open chat with
+            * The Azure Active Directory UPN (e-mail address) of the user to chat with
             */
         user: string;
 }
 /**
-    * @hidden
-    * Hide from docs.
-    * ------
+    * Used when starting a chat with more than one person
     *
-    * @internal
+    * @see OpenSingleChatRequest for use in a chat with only one person
+    *
+    * @beta
     */
 export interface OpenGroupChatRequest extends OpenChatRequest {
         /**
-            * @hidden
-            * Array containing UPNs of users to open chat with
+            * Array containing Azure Active Directory UPNs (e-mail addresss) of users to open chat with
             */
         users: string[];
         /**
-            * @hidden
-            * The display name of a conversation for 3 or more users
+            * The display name of a conversation for 3 or more users (chats with fewer than three users will ignore this field)
             */
         topic?: string;
 }
 /**
-    * @hidden
-    * Namespace to interact with the conversational subEntities inside the tab
+    * Contains functionality to start chat with others
     *
-    * @alpha
+    * @beta
     */
 export namespace chat {
         /**
-            * @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.
+            * @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>;
         /**
-            * @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.

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.21";
+var version = "2.0.0-beta.4-dev.24";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1237,6 +1237,20 @@ var validOrigins = [
  * @internal
  */
 var userOriginUrlValidationRegExp = /^https:\/\//;
+/**
+ * @hidden
+ * The protocol used for deep links into Teams
+ *
+ * @internal
+ */
+var teamsDeepLinkProtocol = 'https';
+/**
+ * @hidden
+ * The host used for deep links into Teams
+ *
+ * @internal
+ */
+var teamsDeepLinkHost = 'teams.microsoft.com';
 
 ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
 var GlobalVars = /** @class */ (function () {
@@ -4248,45 +4262,63 @@ var appInstallDialog;
     appInstallDialog.isSupported = isSupported;
 })(appInstallDialog || (appInstallDialog = {}));
 
+;// CONCATENATED MODULE: ./src/internal/chatConstants.ts
+var teamsDeepLinkUrlPathForChat = '/l/chat/0/0';
+var teamsDeepLinkUsersUrlParameterName = 'users';
+var teamsDeepLinkTopicUrlParameterName = 'topic';
+var teamsDeepLinkMessageUrlParameterName = 'message';
+
+;// CONCATENATED MODULE: ./src/internal/chatUtilities.ts
+
+
+function createTeamsDeepLinkForChat(users, topic, message) {
+    if (users.length === 0) {
+        throw new Error('Must have at least one user when creating a chat deep link');
+    }
+    var usersSearchParameter = teamsDeepLinkUsersUrlParameterName + "=" + users.map(function (user) { return encodeURIComponent(user); }).join(',');
+    var topicSearchParameter = topic === undefined ? '' : "&" + teamsDeepLinkTopicUrlParameterName + "=" + encodeURIComponent(topic);
+    var messageSearchParameter = message === undefined ? '' : "&" + teamsDeepLinkMessageUrlParameterName + "=" + encodeURIComponent(message);
+    return teamsDeepLinkProtocol + "://" + teamsDeepLinkHost + teamsDeepLinkUrlPathForChat + "?" + usersSearchParameter + topicSearchParameter + messageSearchParameter;
+}
+
 ;// CONCATENATED MODULE: ./src/public/chat.ts
 
 
 
 
+
 /**
- * @hidden
- * Namespace to interact with the conversational subEntities inside the tab
+ * Contains functionality to start chat with others
  *
- * @alpha
+ * @beta
  */
 var chat;
 (function (chat) {
     /**
-     * @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.
+     * @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) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
-            var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
-                members: openChatRequest.user,
-                message: openChatRequest.message,
-            });
-            resolve(sendPromise);
+            if (runtime.isLegacyTeams) {
+                resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForChat([openChatRequest.user], undefined /*topic*/, openChatRequest.message)));
+            }
+            else {
+                var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
+                    members: openChatRequest.user,
+                    message: openChatRequest.message,
+                });
+                resolve(sendPromise);
+            }
         });
     }
     chat.openChat = openChat;
     /**
-     * @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.
@@ -4309,12 +4341,17 @@ var chat;
             }
             else {
                 ensureInitialized(FrameContexts.content);
-                var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
-                    members: openChatRequest.users,
-                    message: openChatRequest.message,
-                    topic: openChatRequest.topic,
-                });
-                resolve(sendPromise);
+                if (runtime.isLegacyTeams) {
+                    resolve(sendAndHandleStatusAndReason('executeDeepLink', createTeamsDeepLinkForChat(openChatRequest.users, openChatRequest.topic, openChatRequest.message)));
+                }
+                else {
+                    var sendPromise = sendAndHandleStatusAndReason('chat.openChat', {
+                        members: openChatRequest.users,
+                        message: openChatRequest.message,
+                        topic: openChatRequest.topic,
+                    });
+                    resolve(sendPromise);
+                }
             }
         });
     }