@microsoft/teams-js 2.9.0 → 2.9.1

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.9.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.9.1/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.9.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-wh4L8gn9alg8jFXiHwEw/IgcfK7aT/6Pyby/p5B7zHM+a0Jek5MxzO7AvSlRFvsC"
+  src="https://res.cdn.office.net/teams-js/2.9.1/js/MicrosoftTeams.min.js"
+  integrity="sha384-xnsUQ1tUqsrutBJl0vuf4/hufzLFWW8ZhGnhItfpQ0/BtWgM2uw6YT6BQ5YaKBSM"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.9.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.9.1/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2075,7 +2075,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        interface VideoFrame extends video.VideoFrameData {
+        interface VideoFrame extends video.VideoFrame {
                 /**
                     * @hidden
                     * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
@@ -2647,7 +2647,11 @@ export enum HostName {
         /**
             * Teams
             */
-        teams = "Teams"
+        teams = "Teams",
+        /**
+            * Modern Teams
+            */
+        teamsModern = "TeamsModern"
 }
 export enum FrameContexts {
         settings = "settings",
@@ -4243,7 +4247,15 @@ export namespace chat {
 export {};
 
 /**
-    * Namespace to interact with the dialog module-specific part of the SDK.
+    * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
+    * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
+    * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
+    *   - For URL dialogs, use the functions and interfaces in the {@link dialog.url} namespace.
+    * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
+    *   - For Adaptive Card dialogs, use the functions and interfaces in the {@link dialog.adaptiveCard} namespace.
+    *
+    * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
+    * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
     *
     * @beta
     */
@@ -4274,6 +4286,9 @@ export namespace dialog {
         /**
             * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode url.submit}
             * or an error if the dialog was closed by the user.
+            *
+            * @see {@linkcode ISdkResponse}
+            *
             * @beta
             */
         type DialogSubmitHandler = (result: ISdkResponse) => void;
@@ -4406,14 +4421,11 @@ export namespace dialog {
                 function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
         }
         /**
-            * Checks if dialog capability is supported by the host
-            * @returns boolean to represent whether dialog capabilty is supported
-            *
-            * @throws Error if {@linkcode app.initialize} has not successfully completed
-            *
-            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            * This function currently serves no purpose and should not be used. All functionality that used
+            * to be covered by this method is now in subcapabilities and those isSupported methods should be
+            * used directly.
             *
-            * @beta
+            * @hidden
             */
         function isSupported(): boolean;
         /**
@@ -6671,7 +6683,7 @@ export namespace video {
             * Represents a video frame
             * @beta
             */
-        interface VideoFrameData {
+        interface VideoFrame {
                 /**
                     * Video frame width
                     */
@@ -6683,7 +6695,7 @@ export namespace video {
                 /**
                     * Video frame buffer
                     */
-                videoFrameBuffer: Uint8ClampedArray;
+                data: Uint8ClampedArray;
                 /**
                     * NV12 luma stride, valid only when video frame format is NV12
                     */
@@ -6706,7 +6718,7 @@ export namespace video {
             * @beta
             */
         enum VideoFrameFormat {
-                NV12 = "NV12"
+                NV12 = 0
         }
         /**
             * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
@@ -6736,7 +6748,7 @@ export namespace video {
             * Video frame call back function definition
             * @beta
             */
-        type VideoFrameCallback = (frame: VideoFrameData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
         /**
             * Predefined failure reasons for preparing the selected video effect
             * @beta
@@ -6789,56 +6801,6 @@ export namespace video {
             *
             */
         function isSupported(): boolean;
-        /**
-            * @beta
-            * Namespace to get video frames from a media stream.
-            * When the host supports this capability, developer should call {@link mediaStream.registerForVideoFrame} to get the video frames instead of {@link registerForVideoFrame} to get the video frames, callback of {@link registerForVideoFrame} will be ignored when the host supports this capability.
-            */
-        namespace mediaStream {
-                /**
-                    * @beta
-                    * Checks if video.mediaStream capability is supported by the host
-                    * @returns boolean to represent whether the video.medisStream capability is supported
-                    *
-                    * @throws Error if {@linkcode app.initialize} has not successfully completed
-                    *
-                    */
-                function isSupported(): boolean;
-                /**
-                    * @beta
-                    * Video frame data extracted from the media stream. More properties may be added in the future.
-                    */
-                type MediaStreamFrameData = {
-                        /**
-                            * The video frame from the media stream.
-                            */
-                        videoFrame: VideoFrame;
-                };
-                /**
-                    * @beta
-                    * Video effect change call back function definition.
-                    * The video app should resolve the promise to notify a successfully processed video frame.
-                    * The video app should reject the promise to notify a failure.
-                    */
-                type VideoFrameCallback = (receivedVideoFrame: MediaStreamFrameData) => Promise<VideoFrame>;
-                /**
-                    * @beta
-                    * Register to read the video frames from the media stream provided by the host.
-                    * @param frameCallback - The callback to invoke when recieve a video frame from the media stream.
-                    * @example
-                    * ```typescript
-                    * video.mediaStream.registerForVideoFrame(async (receivedVideoFrame) => {
-                    *  const { videoFrame } = receivedVideoFrame;
-                    *  try {
-                    *    return await processVideoFrame(videoFrame);
-                    *  } catch (error) {
-                    *   throw error;
-                    *  }
-                    * });
-                    * ```
-                    */
-                function registerForVideoFrame(frameCallback: VideoFrameCallback): void;
-        }
 }
 
 /**
@@ -7519,9 +7481,13 @@ export namespace settings {
 export namespace tasks {
         /**
             * @deprecated
-            * As of 2.8.0, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
-            * and {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot-based dialogs. In Teams,
-            * this function can be used for Adaptive Card-based dialogs. Support for Adaptive Card-based dialogs is coming to other hosts in the future.
+            * As of 2.8.0:
+            * - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
+            * - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
+            * - For Adaptive Card-based dialogs:
+            *   - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
+            *     the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
+            *   - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
             *
             * Allows an app to open the task module.
             *

package/dist/MicrosoftTeams.js

@@ -7,7 +7,7 @@
 		exports["microsoftTeams"] = factory();
 	else
 		root["microsoftTeams"] = factory();
-})(self, function() {
+})(self, () => {
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -1477,6 +1477,10 @@ var HostName;
      * Teams
      */
     HostName["teams"] = "Teams";
+    /**
+     * Modern Teams
+     */
+    HostName["teamsModern"] = "TeamsModern";
 })(HostName || (HostName = {}));
 // Ensure these declarations stay in sync with the framework.
 var FrameContexts;
@@ -2151,7 +2155,7 @@ var _minRuntimeConfigToUninitialize = {
 };
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.9.0";
+var version = "2.9.1";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -2713,7 +2717,15 @@ var authentication;
 
 
 /**
- * Namespace to interact with the dialog module-specific part of the SDK.
+ * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
+ * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
+ * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
+ *   - For URL dialogs, use the functions and interfaces in the {@link dialog.url} namespace.
+ * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
+ *   - For Adaptive Card dialogs, use the functions and interfaces in the {@link dialog.adaptiveCard} namespace.
+ *
+ * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
+ * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
  *
  * @beta
  */
@@ -2962,14 +2974,11 @@ var dialog;
         url.getDialogInfoFromBotUrlDialogInfo = getDialogInfoFromBotUrlDialogInfo;
     })(url = dialog.url || (dialog.url = {}));
     /**
-     * Checks if dialog capability is supported by the host
-     * @returns boolean to represent whether dialog capabilty is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     * This function currently serves no purpose and should not be used. All functionality that used
+     * to be covered by this method is now in subcapabilities and those isSupported methods should be
+     * used directly.
      *
-     * @beta
+     * @hidden
      */
     function isSupported() {
         return ensureInitialized(runtime) && runtime.supports.dialog ? true : false;
@@ -7781,53 +7790,6 @@ var profile;
 })(profile || (profile = {}));
 
 ;// CONCATENATED MODULE: ./src/public/video.ts
-var video_assign = (undefined && undefined.__assign) || function () {
-    video_assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return video_assign.apply(this, arguments);
-};
-var video_awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var video_generator = (undefined && undefined.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 
 
 
@@ -7845,7 +7807,7 @@ var video;
      */
     var VideoFrameFormat;
     (function (VideoFrameFormat) {
-        VideoFrameFormat["NV12"] = "NV12";
+        VideoFrameFormat[VideoFrameFormat["NV12"] = 0] = "NV12";
     })(VideoFrameFormat = video.VideoFrameFormat || (video.VideoFrameFormat = {}));
     /**
      * Video effect change type enum
@@ -7889,14 +7851,10 @@ var video;
         if (!isSupported()) {
             throw errorNotSupportedOnPlatform;
         }
-        registerHandler('video.newVideoFrame', 
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        function (videoFrame) {
+        registerHandler('video.newVideoFrame', function (videoFrame) {
             if (videoFrame) {
-                // The host may pass the VideoFrame with the old definition which has `data` instead of `videoFrameBuffer`
-                var videoFrameData = video_assign(video_assign({}, videoFrame), { videoFrameBuffer: videoFrame.videoFrameBuffer || videoFrame.data });
-                var timestamp_1 = videoFrameData.timestamp;
-                frameCallback(videoFrameData, function () {
+                var timestamp_1 = videoFrame.timestamp;
+                frameCallback(videoFrame, function () {
                     notifyVideoFrameProcessed(timestamp_1);
                 }, notifyError);
             }
@@ -7972,165 +7930,6 @@ var video;
         return ensureInitialized(runtime) && runtime.supports.video ? true : false;
     }
     video.isSupported = isSupported;
-    /**
-     * @beta
-     * Namespace to get video frames from a media stream.
-     * When the host supports this capability, developer should call {@link mediaStream.registerForVideoFrame} to get the video frames instead of {@link registerForVideoFrame} to get the video frames, callback of {@link registerForVideoFrame} will be ignored when the host supports this capability.
-     */
-    var mediaStream;
-    (function (mediaStream_1) {
-        /**
-         * @beta
-         * Checks if video.mediaStream capability is supported by the host
-         * @returns boolean to represent whether the video.medisStream capability is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         */
-        function isSupported() {
-            var _a;
-            return ensureInitialized(runtime) && isTextureStreamAvailable() && !!((_a = runtime.supports.video) === null || _a === void 0 ? void 0 : _a.mediaStream);
-        }
-        mediaStream_1.isSupported = isSupported;
-        function isTextureStreamAvailable() {
-            var _a, _b, _c, _d;
-            return (typeof window !== 'undefined' &&
-                !!(((_b = (_a = window['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.getTextureStream) && ((_d = (_c = window['chrome']) === null || _c === void 0 ? void 0 : _c.webview) === null || _d === void 0 ? void 0 : _d.registerTextureStream)));
-        }
-        /**
-         * @beta
-         * Register to read the video frames from the media stream provided by the host.
-         * @param frameCallback - The callback to invoke when recieve a video frame from the media stream.
-         * @example
-         * ```typescript
-         * video.mediaStream.registerForVideoFrame(async (receivedVideoFrame) => {
-         *  const { videoFrame } = receivedVideoFrame;
-         *  try {
-         *    return await processVideoFrame(videoFrame);
-         *  } catch (error) {
-         *   throw error;
-         *  }
-         * });
-         * ```
-         */
-        function registerForVideoFrame(frameCallback) {
-            var _this = this;
-            ensureInitialized(runtime, FrameContexts.sidePanel);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            registerHandler('video.startVideoExtensibilityVideoStream', function (mediaStreamInfo) { return video_awaiter(_this, void 0, void 0, function () {
-                var streamId, videoTrack, generator;
-                var _a, _b;
-                return video_generator(this, function (_c) {
-                    switch (_c.label) {
-                        case 0:
-                            streamId = mediaStreamInfo.streamId;
-                            return [4 /*yield*/, getInputVideoTrack(streamId)];
-                        case 1:
-                            videoTrack = _c.sent();
-                            generator = createProcessedStreamGenerator(videoTrack, frameCallback);
-                            // register the video track with processed frames back to the stream:
-                            typeof window !== 'undefined' && ((_b = (_a = window['chrome']) === null || _a === void 0 ? void 0 : _a.webview) === null || _b === void 0 ? void 0 : _b.registerTextureStream(streamId, generator));
-                            return [2 /*return*/];
-                    }
-                });
-            }); });
-            sendMessageToParent('video.registerForVideoFrame', [
-                {
-                    format: VideoFrameFormat.NV12,
-                },
-            ]);
-        }
-        mediaStream_1.registerForVideoFrame = registerForVideoFrame;
-        /**
-         * Get the video track from the media stream gotten from chrome.webview.getTextureStream(streamId).
-         */
-        function getInputVideoTrack(streamId) {
-            return video_awaiter(this, void 0, void 0, function () {
-                var chrome, mediaStream_2, tracks, error_1, errorMsg;
-                return video_generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            if (typeof window === 'undefined') {
-                                throw errorNotSupportedOnPlatform;
-                            }
-                            chrome = window['chrome'];
-                            _a.label = 1;
-                        case 1:
-                            _a.trys.push([1, 3, , 4]);
-                            return [4 /*yield*/, chrome.webview.getTextureStream(streamId)];
-                        case 2:
-                            mediaStream_2 = _a.sent();
-                            tracks = mediaStream_2.getVideoTracks();
-                            if (tracks.length === 0) {
-                                throw new Error("No video track in stream ".concat(streamId));
-                            }
-                            return [2 /*return*/, tracks[0]];
-                        case 3:
-                            error_1 = _a.sent();
-                            errorMsg = "Failed to get video track from stream ".concat(streamId, ", error: ").concat(error_1);
-                            notifyError(errorMsg);
-                            throw new Error(errorMsg);
-                        case 4: return [2 /*return*/];
-                    }
-                });
-            });
-        }
-        /**
-         * The function to create a processed video track from the original video track.
-         * It reads frames from the video track and pipes them to the video frame callback to process the frames.
-         * The processed frames are then enqueued to the generator.
-         * The generator can be registered back to the media stream so that the host can get the processed frames.
-         */
-        function createProcessedStreamGenerator(videoTrack, videoFrameCallback) {
-            var processor = new MediaStreamTrackProcessor({ track: videoTrack });
-            var source = processor.readable;
-            var generator = new MediaStreamTrackGenerator({ kind: 'video' });
-            var sink = generator.writable;
-            source
-                .pipeThrough(new TransformStream({
-                transform: function (originalFrame, controller) {
-                    return video_awaiter(this, void 0, void 0, function () {
-                        var timestamp, frameProcessedByApp, processedFrame, error_2;
-                        return video_generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    timestamp = originalFrame.timestamp;
-                                    if (!(timestamp !== null)) return [3 /*break*/, 5];
-                                    _a.label = 1;
-                                case 1:
-                                    _a.trys.push([1, 3, , 4]);
-                                    return [4 /*yield*/, videoFrameCallback({ videoFrame: originalFrame })];
-                                case 2:
-                                    frameProcessedByApp = _a.sent();
-                                    processedFrame = new VideoFrame(frameProcessedByApp, {
-                                        // we need the timestamp to be unchanged from the oirginal frame, so we explicitly set it here.
-                                        timestamp: timestamp,
-                                    });
-                                    controller.enqueue(processedFrame);
-                                    originalFrame.close();
-                                    frameProcessedByApp.close();
-                                    return [3 /*break*/, 4];
-                                case 3:
-                                    error_2 = _a.sent();
-                                    originalFrame.close();
-                                    notifyError(error_2);
-                                    return [3 /*break*/, 4];
-                                case 4: return [3 /*break*/, 6];
-                                case 5:
-                                    notifyError('timestamp of the original video frame is null');
-                                    _a.label = 6;
-                                case 6: return [2 /*return*/];
-                            }
-                        });
-                    });
-                },
-            }))
-                .pipeTo(sink);
-            return generator;
-        }
-    })(mediaStream = video.mediaStream || (video.mediaStream = {}));
 })(video || (video = {})); //end of video namespace
 
 ;// CONCATENATED MODULE: ./src/public/search.ts
@@ -9033,9 +8832,13 @@ var tasks;
 (function (tasks) {
     /**
      * @deprecated
-     * As of 2.8.0, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
-     * and {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot-based dialogs. In Teams,
-     * this function can be used for Adaptive Card-based dialogs. Support for Adaptive Card-based dialogs is coming to other hosts in the future.
+     * As of 2.8.0:
+     * - For url-based dialogs, please use {@link dialog.url.open dialog.url.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} .
+     * - For url-based dialogs with bot interaction, please use {@link dialog.url.bot.open dialog.url.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
+     * - For Adaptive Card-based dialogs:
+     *   - In Teams, please continue to use this function until the new functions in {@link dialog.adaptiveCard} have been fully implemented. You can tell at runtime when they are implemented in Teams by checking
+     *     the return value of the {@link dialog.adaptiveCard.isSupported} function. This documentation line will also be removed once they have been fully implemented in Teams.
+     *   - In all other hosts, please use {@link dialog.adaptiveCard.open dialog.adaptiveCard.open(cardDialogInfo: CardDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void}
      *
      * Allows an app to open the task module.
      *