@microsoft/teams-js 2.10.1 → 2.11.0-beta.1

package/dist/MicrosoftTeams.js

@@ -843,6 +843,7 @@ __webpack_require__.d(__webpack_exports__, {
   "getTabInstances": () => (/* reexport */ getTabInstances),
   "initialize": () => (/* reexport */ initialize),
   "initializeWithFrameContext": () => (/* reexport */ initializeWithFrameContext),
+  "isSupported": () => (/* reexport */ isSupported),
   "location": () => (/* reexport */ location_location),
   "logs": () => (/* reexport */ logs),
   "mail": () => (/* reexport */ mail),
@@ -1181,8 +1182,11 @@ function v4(options, buf, offset) {
  */
 var FileOpenPreference;
 (function (FileOpenPreference) {
+    /** Indicates that the user should be prompted to open the file in inline. */
     FileOpenPreference["Inline"] = "inline";
+    /** Indicates that the user should be prompted to open the file in the native desktop application associated with the file type. */
     FileOpenPreference["Desktop"] = "desktop";
+    /** Indicates that the user should be prompted to open the file in a web browser. */
     FileOpenPreference["Web"] = "web";
 })(FileOpenPreference || (FileOpenPreference = {}));
 /**
@@ -1192,20 +1196,26 @@ var FileOpenPreference;
  */
 var ActionObjectType;
 (function (ActionObjectType) {
+    /** Represents content within a Microsoft 365 application. */
     ActionObjectType["M365Content"] = "m365content";
 })(ActionObjectType || (ActionObjectType = {}));
 /**
- * These correspond with field names in the MSGraph
- *
+ * These correspond with field names in the MSGraph.
+ * See (commonly accessed resources)[https://learn.microsoft.com/en-us/graph/api/resources/onedrive?view=graph-rest-1.0#commonly-accessed-resources].
  * @beta
  */
 var SecondaryM365ContentIdName;
 (function (SecondaryM365ContentIdName) {
+    /** OneDrive ID */
     SecondaryM365ContentIdName["DriveId"] = "driveId";
+    /** Teams Group ID */
     SecondaryM365ContentIdName["GroupId"] = "groupId";
+    /** SharePoint ID */
     SecondaryM365ContentIdName["SiteId"] = "siteId";
+    /** User ID */
     SecondaryM365ContentIdName["UserId"] = "userId";
 })(SecondaryM365ContentIdName || (SecondaryM365ContentIdName = {}));
+/** Error codes used to identify different types of errors that can occur while developing apps. */
 var ErrorCode;
 (function (ErrorCode) {
     /**
@@ -1277,24 +1287,36 @@ var DevicePermission;
 })(DevicePermission || (DevicePermission = {}));
 
 ;// CONCATENATED MODULE: ./src/public/constants.ts
+/** HostClientType represents the different client platforms on which host can be run. */
 var HostClientType;
 (function (HostClientType) {
+    /** Represents the desktop client of host, which is installed on a user's computer and runs as a standalone application. */
     HostClientType["desktop"] = "desktop";
+    /** Represents the web-based client of host, which runs in a web browser. */
     HostClientType["web"] = "web";
+    /** Represents the Android mobile client of host, which runs on Android devices such as smartphones and tablets. */
     HostClientType["android"] = "android";
+    /** Represents the iOS mobile client of host, which runs on iOS devices such as iPhones. */
     HostClientType["ios"] = "ios";
+    /** Represents the iPadOS client of host, which runs on iOS devices such as iPads. */
     HostClientType["ipados"] = "ipados";
     /**
      * @deprecated
      * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
      */
     HostClientType["rigel"] = "rigel";
+    /** Represents the client of host, which runs on surface hub devices. */
     HostClientType["surfaceHub"] = "surfaceHub";
+    /** Represents the client of host, which runs on Teams Rooms on Windows devices. More information on Microsoft Teams Rooms on Windows can be found [Microsoft Teams Rooms (Windows)](https://support.microsoft.com/office/microsoft-teams-rooms-windows-help-e667f40e-5aab-40c1-bd68-611fe0002ba2)*/
     HostClientType["teamsRoomsWindows"] = "teamsRoomsWindows";
+    /** Represents the client of host, which runs on Teams Rooms on Android devices. More information on Microsoft Teams Rooms on Android can be found [Microsoft Teams Rooms (Android)].(https://support.microsoft.com/office/get-started-with-teams-rooms-on-android-68517298-d513-46be-8d6d-d41db5e6b4b2)*/
     HostClientType["teamsRoomsAndroid"] = "teamsRoomsAndroid";
+    /** Represents the client of host, which runs on Teams phones. More information can be found [Microsoft Teams Phones](https://support.microsoft.com/office/get-started-with-teams-phones-694ca17d-3ecf-40ca-b45e-d21b2c442412) */
     HostClientType["teamsPhones"] = "teamsPhones";
+    /** Represents the client of host, which runs on Teams displays devices. More information can be found [Microsoft Teams Displays](https://support.microsoft.com/office/get-started-with-teams-displays-ff299825-7f13-4528-96c2-1d3437e6d4e6) */
     HostClientType["teamsDisplays"] = "teamsDisplays";
 })(HostClientType || (HostClientType = {}));
+/** HostName indicates the possible hosts for your application. */
 var HostName;
 (function (HostName) {
     /**
@@ -1323,16 +1345,36 @@ var HostName;
      */
     HostName["teamsModern"] = "TeamsModern";
 })(HostName || (HostName = {}));
-// Ensure these declarations stay in sync with the framework.
+/**
+ * FrameContexts provides information about the context in which the app is running within the host.
+ * Developers can use FrameContexts to determine how their app should behave in different contexts,
+ * and can use the information provided by the context to adapt the app to the user's needs.
+ *
+ * @example
+ * If your app is running in the "settings" context, you should be displaying your apps configuration page.
+ * If the app is running in the content context, the developer may want to display information relevant to
+ * the content the user is currently viewing.
+ */
 var FrameContexts;
 (function (FrameContexts) {
+    /**
+     * App's frame context from where settings page can be accessed.
+     * See [how to create a configuration page.]( https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/create-tab-pages/configuration-page?tabs=teamsjs-v2)
+     */
     FrameContexts["settings"] = "settings";
+    /** The default context for the app where all the content of the app is displayed. */
     FrameContexts["content"] = "content";
+    /** Frame context used when app is running in the authentication window launched by calling {@link authentication.authenticate} */
     FrameContexts["authentication"] = "authentication";
+    /** The page shown when the user uninstalls the app. */
     FrameContexts["remove"] = "remove";
+    /** A task module is a pop-up window that can be used to display a form, a dialog, or other interactive content within the host. */
     FrameContexts["task"] = "task";
+    /** The side panel is a persistent panel that is displayed on the right side of the host and can be used to display content or UI that is relevant to the current page or tab. */
     FrameContexts["sidePanel"] = "sidePanel";
+    /** The stage is a large area that is displayed at the center of the host and can be used to display content or UI that requires a lot of space, such as a video player or a document editor. */
     FrameContexts["stage"] = "stage";
+    /** App's frame context from where meetingStage can be accessed in a meeting session, which is the primary area where video and presentation content is displayed during a meeting. */
     FrameContexts["meetingStage"] = "meetingStage";
 })(FrameContexts || (FrameContexts = {}));
 /**
@@ -1341,10 +1383,15 @@ var FrameContexts;
  */
 var TeamType;
 (function (TeamType) {
+    /** Represents a standard or classic team in host that is designed for ongoing collaboration and communication among a group of people. */
     TeamType[TeamType["Standard"] = 0] = "Standard";
+    /**  Represents an educational team in host that is designed for classroom collaboration and communication among students and teachers. */
     TeamType[TeamType["Edu"] = 1] = "Edu";
+    /** Represents a class team in host that is designed for classroom collaboration and communication among students and teachers in a structured environment. */
     TeamType[TeamType["Class"] = 2] = "Class";
+    /** Represents a professional learning community (PLC) team in host that is designed for educators to collaborate and share resources and best practices. */
     TeamType[TeamType["Plc"] = 3] = "Plc";
+    /** Represents a staff team in host that is designed for staff collaboration and communication among staff members.*/
     TeamType[TeamType["Staff"] = 4] = "Staff";
 })(TeamType || (TeamType = {}));
 /**
@@ -1352,8 +1399,11 @@ var TeamType;
  */
 var UserTeamRole;
 (function (UserTeamRole) {
+    /** Represents that the user is an owner or administrator of the team. */
     UserTeamRole[UserTeamRole["Admin"] = 0] = "Admin";
+    /** Represents that the user is a standard member of the team. */
     UserTeamRole[UserTeamRole["User"] = 1] = "User";
+    /** Represents that the user does not have any role in the team. */
     UserTeamRole[UserTeamRole["Guest"] = 2] = "Guest";
 })(UserTeamRole || (UserTeamRole = {}));
 /**
@@ -1361,8 +1411,11 @@ var UserTeamRole;
  */
 var DialogDimension;
 (function (DialogDimension) {
+    /** Represents a large-sized dialog box, which is typically used for displaying large amounts of content or complex workflows that require more space. */
     DialogDimension["Large"] = "large";
+    /** Represents a medium-sized dialog box, which is typically used for displaying moderate amounts of content or workflows that require less space. */
     DialogDimension["Medium"] = "medium";
+    /** Represents a small-sized dialog box, which is typically used for displaying simple messages or workflows that require minimal space.*/
     DialogDimension["Small"] = "small";
 })(DialogDimension || (DialogDimension = {}));
 
@@ -1377,10 +1430,16 @@ var TaskModuleDimension = DialogDimension;
  */
 var ChannelType;
 (function (ChannelType) {
+    /** The default channel type. Type of channel is used for general collaboration and communication within a team. */
     ChannelType["Regular"] = "Regular";
+    /** Type of channel is used for sensitive or confidential communication within a team and is only accessible to members of the channel. */
     ChannelType["Private"] = "Private";
+    /** Type of channel is used for collaboration between multiple teams or groups and is accessible to members of all the teams or groups. */
     ChannelType["Shared"] = "Shared";
 })(ChannelType || (ChannelType = {}));
+/** An error object indicating that the requested operation or feature is not supported on the current platform or device.
+ * @typedef {Object} SdkError
+ */
 var errorNotSupportedOnPlatform = { errorCode: ErrorCode.NOT_SUPPORTED_ON_PLATFORM };
 /**
  * @hidden
@@ -1797,6 +1856,7 @@ var teamsRuntimeConfig = {
             },
             update: {},
         },
+        interactive: {},
         logs: {},
         meetingRoom: {},
         menus: {},
@@ -1999,7 +2059,11 @@ var _minRuntimeConfigToUninitialize = {
 };
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.10.1";
+/**
+ * @hidden
+ *  Package version.
+ */
+var version = "2.11.0-beta.1";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3096,6 +3160,13 @@ var menus;
     var navBarMenuItemPressHandler;
     var actionMenuItemPressHandler;
     var viewConfigItemPressHandler;
+    /**
+     * @hidden
+     * Register navBarMenuItemPress, actionMenuItemPress, setModuleView handlers.
+     *
+     * @internal
+     * Limited to Microsoft-internal use.
+     */
     function initialize() {
         registerHandler('navBarMenuItemPress', handleNavBarMenuItemPress, false);
         registerHandler('actionMenuItemPress', handleActionMenuItemPress, false);
@@ -3345,10 +3416,15 @@ var app;
 (function (app) {
     var appLogger = getLogger('app');
     // ::::::::::::::::::::::: MicrosoftTeams client SDK public API ::::::::::::::::::::
+    /** App Initialization Messages */
     app.Messages = {
+        /** App loaded. */
         AppLoaded: 'appInitialization.appLoaded',
+        /** App initialized successfully. */
         Success: 'appInitialization.success',
+        /** App initialization failed. */
         Failure: 'appInitialization.failure',
+        /** App initialization expected failure. */
         ExpectedFailure: 'appInitialization.expectedFailure',
     };
     /**
@@ -4121,16 +4197,16 @@ var pages;
         }
         config.registerOnRemoveHandlerHelper = registerOnRemoveHandlerHelper;
         function handleSave(result) {
-            var saveEvent = new SaveEventImpl(result);
+            var saveEventType = new SaveEventImpl(result);
             if (saveHandler) {
-                saveHandler(saveEvent);
+                saveHandler(saveEventType);
             }
             else if (Communication.childWindow) {
                 sendMessageEventToChild('settings.save', [result]);
             }
             else {
                 // If no handler is registered, we assume success.
-                saveEvent.notifySuccess();
+                saveEventType.notifySuccess();
             }
         }
         /**
@@ -4172,16 +4248,16 @@ var pages;
             return SaveEventImpl;
         }());
         function handleRemove() {
-            var removeEvent = new RemoveEventImpl();
+            var removeEventType = new RemoveEventImpl();
             if (removeHandler) {
-                removeHandler(removeEvent);
+                removeHandler(removeEventType);
             }
             else if (Communication.childWindow) {
                 sendMessageEventToChild('settings.remove', []);
             }
             else {
                 // If no handler is registered, we assume success.
-                removeEvent.notifySuccess();
+                removeEventType.notifySuccess();
             }
         }
         /**
@@ -4204,7 +4280,7 @@ var pages;
             };
             RemoveEventImpl.prototype.ensureNotNotified = function () {
                 if (this.notified) {
-                    throw new Error('The removeEvent may only notify success or failure once.');
+                    throw new Error('The removeEventType may only notify success or failure once.');
                 }
             };
             return RemoveEventImpl;
@@ -4230,6 +4306,13 @@ var pages;
     var backStack;
     (function (backStack) {
         var backButtonPressHandler;
+        /**
+         * @hidden
+         * Register backButtonPress handler.
+         *
+         * @internal
+         * Limited to Microsoft-internal use.
+         */
         function _initialize() {
             registerHandler('backButtonPress', handleBackButtonPress, false);
         }
@@ -5605,6 +5688,11 @@ function createTeamsDeepLinkForAppInstallDialog(appId) {
 
 var appInstallDialog;
 (function (appInstallDialog) {
+    /**
+     * Displays a dialog box that allows users to install a specific app within the host environment.
+     *
+     * @param openAPPInstallDialogParams - See {@link OpenAppInstallDialogParams | OpenAppInstallDialogParams} for more information.
+     */
     function openAppInstallDialog(openAPPInstallDialogParams) {
         return new Promise(function (resolve) {
             ensureInitialized(runtime, FrameContexts.content, FrameContexts.sidePanel, FrameContexts.settings, FrameContexts.task, FrameContexts.stage, FrameContexts.meetingStage);
@@ -5660,6 +5748,9 @@ var __extends = (undefined && undefined.__extends) || (function () {
 
 
 
+/**
+ * Interact with media, including capturing and viewing images.
+ */
 var media;
 (function (media) {
     /**
@@ -5667,7 +5758,9 @@ var media;
      */
     var FileFormat;
     (function (FileFormat) {
+        /** Base64 encoding */
         FileFormat["Base64"] = "base64";
+        /** File id */
         FileFormat["ID"] = "id";
     })(FileFormat = media.FileFormat || (media.FileFormat = {}));
     /**
@@ -5757,6 +5850,7 @@ var media;
                 this.getMediaViaHandler(callback);
             }
         };
+        /** Function to retrieve media content, such as images or videos, via callback. */
         Media.prototype.getMediaViaCallback = function (callback) {
             var helper = {
                 mediaMimeType: this.mimeType,
@@ -5792,6 +5886,7 @@ var media;
             }
             sendMessageToParent('getMedia', localUriId, handleGetMediaCallbackRequest);
         };
+        /** Function to retrieve media content, such as images or videos, via handler. */
         Media.prototype.getMediaViaHandler = function (callback) {
             var actionName = generateGUID();
             var helper = {
@@ -5890,9 +5985,11 @@ var media;
         function VideoController() {
             return _super !== null && _super.apply(this, arguments) || this;
         }
+        /** Gets media type video. */
         VideoController.prototype.getMediaType = function () {
             return MediaType.Video;
         };
+        /** Notify or send an event related to the playback and control of video content to a registered application. */
         VideoController.prototype.notifyEventToApp = function (mediaEvent) {
             if (!this.controllerCallback) {
                 // Early return as app has not registered with the callback
@@ -5915,7 +6012,9 @@ var media;
      */
     var MediaControllerEvent;
     (function (MediaControllerEvent) {
+        /** Start recording. */
         MediaControllerEvent[MediaControllerEvent["StartRecording"] = 1] = "StartRecording";
+        /** Stop recording. */
         MediaControllerEvent[MediaControllerEvent["StopRecording"] = 2] = "StopRecording";
     })(MediaControllerEvent = media.MediaControllerEvent || (media.MediaControllerEvent = {}));
     /**
@@ -5923,9 +6022,13 @@ var media;
      */
     var CameraStartMode;
     (function (CameraStartMode) {
+        /** Photo mode. */
         CameraStartMode[CameraStartMode["Photo"] = 1] = "Photo";
+        /** Document mode. */
         CameraStartMode[CameraStartMode["Document"] = 2] = "Document";
+        /** Whiteboard mode. */
         CameraStartMode[CameraStartMode["Whiteboard"] = 3] = "Whiteboard";
+        /** Business card mode. */
         CameraStartMode[CameraStartMode["BusinessCard"] = 4] = "BusinessCard";
     })(CameraStartMode = media.CameraStartMode || (media.CameraStartMode = {}));
     /**
@@ -5933,7 +6036,9 @@ var media;
      */
     var Source;
     (function (Source) {
+        /** Image source is camera. */
         Source[Source["Camera"] = 1] = "Camera";
+        /** Image source is gallery. */
         Source[Source["Gallery"] = 2] = "Gallery";
     })(Source = media.Source || (media.Source = {}));
     /**
@@ -5941,9 +6046,13 @@ var media;
      */
     var MediaType;
     (function (MediaType) {
+        /** Media type photo or image */
         MediaType[MediaType["Image"] = 1] = "Image";
+        /** Media type video. */
         MediaType[MediaType["Video"] = 2] = "Video";
+        /** Media type video and image. */
         MediaType[MediaType["VideoAndImage"] = 3] = "VideoAndImage";
+        /** Media type audio. */
         MediaType[MediaType["Audio"] = 4] = "Audio";
     })(MediaType = media.MediaType || (media.MediaType = {}));
     /**
@@ -5951,7 +6060,9 @@ var media;
      */
     var ImageUriType;
     (function (ImageUriType) {
+        /** Image Id. */
         ImageUriType[ImageUriType["ID"] = 1] = "ID";
+        /** Image URL. */
         ImageUriType[ImageUriType["URL"] = 2] = "URL";
     })(ImageUriType = media.ImageUriType || (media.ImageUriType = {}));
     /**
@@ -5959,7 +6070,9 @@ var media;
      */
     var ImageOutputFormats;
     (function (ImageOutputFormats) {
+        /** Outputs image.  */
         ImageOutputFormats[ImageOutputFormats["IMAGE"] = 1] = "IMAGE";
+        /** Outputs pdf. */
         ImageOutputFormats[ImageOutputFormats["PDF"] = 2] = "PDF";
     })(ImageOutputFormats = media.ImageOutputFormats || (media.ImageOutputFormats = {}));
     /**
@@ -6657,6 +6770,10 @@ function getAdaptiveCardSchemaVersion() {
 
 
 
+/**
+ * An object that application can utilize to establish communication
+ * with the child window it opened, which contains the corresponding task.
+ */
 var ChildAppWindow = /** @class */ (function () {
     function ChildAppWindow() {
     }
@@ -6685,10 +6802,16 @@ var ChildAppWindow = /** @class */ (function () {
     return ChildAppWindow;
 }());
 
+/**
+ * An object that is utilized to facilitate communication with a parent window
+ * that initiated the opening of current window. For instance, a dialog or task
+ * module would utilize it to transmit messages to the application that launched it.
+ */
 var ParentAppWindow = /** @class */ (function () {
     function ParentAppWindow() {
     }
     Object.defineProperty(ParentAppWindow, "Instance", {
+        /** Get the parent window instance. */
         get: function () {
             // Do you need arguments? Make it a regular method instead.
             return this._instance || (this._instance = new this());
@@ -6848,6 +6971,11 @@ var __generator = (undefined && undefined.__generator) || function (thisArg, bod
 
 
 
+/**
+ * Interact with meetings, including retrieving meeting details, getting mic status, and sharing app content.
+ * This namespace is used to handle meeting related functionality like
+ * get meeting details, get/update state of mic, sharing app content and more.
+ */
 var meeting;
 (function (meeting) {
     /**
@@ -6879,18 +7007,28 @@ var meeting;
         MeetingReactionType["surprised"] = "surprised";
         MeetingReactionType["applause"] = "applause";
     })(MeetingReactionType = meeting.MeetingReactionType || (meeting.MeetingReactionType = {}));
+    /** Represents the type of a meeting */
     var MeetingType;
     (function (MeetingType) {
+        /** Used when the meeting type is not known. */
         MeetingType["Unknown"] = "Unknown";
+        /** Used for ad hoc meetings that are created on the fly. */
         MeetingType["Adhoc"] = "Adhoc";
+        /** Used for meetings that have been scheduled in advance. */
         MeetingType["Scheduled"] = "Scheduled";
+        /** Used for meetings that occur on a recurring basis. */
         MeetingType["Recurring"] = "Recurring";
+        /** Used for live events or webinars. */
         MeetingType["Broadcast"] = "Broadcast";
+        /** Used for meetings that are created on the fly, but with a more polished experience than ad hoc meetings. */
         MeetingType["MeetNow"] = "MeetNow";
     })(MeetingType = meeting.MeetingType || (meeting.MeetingType = {}));
+    /** Represents the type of a call. */
     var CallType;
     (function (CallType) {
+        /** Represents a call between two people. */
         CallType["OneOnOneCall"] = "oneOnOneCall";
+        /** Represents a call between more than two people. */
         CallType["GroupCall"] = "groupCall";
     })(CallType = meeting.CallType || (meeting.CallType = {}));
     /**
@@ -7360,8 +7498,16 @@ var monetization;
 
 
 
+/**
+ * Interact with the user's calendar, including opening calendar items and composing meetings.
+ */
 var calendar;
 (function (calendar) {
+    /**
+     * Opens a calendar item.
+     *
+     * @param openCalendarItemParams - object containing unique ID of the calendar item to be opened.
+     */
     function openCalendarItem(openCalendarItemParams) {
         return new Promise(function (resolve) {
             ensureInitialized(runtime, FrameContexts.content);
@@ -7375,6 +7521,11 @@ var calendar;
         });
     }
     calendar.openCalendarItem = openCalendarItem;
+    /**
+     * Compose a new meeting in the user's calendar.
+     *
+     * @param composeMeetingParams - object containing various properties to set up the meeting details.
+     */
     function composeMeeting(composeMeetingParams) {
         return new Promise(function (resolve) {
             ensureInitialized(runtime, FrameContexts.content);
@@ -7407,8 +7558,16 @@ var calendar;
 
 
 
+/**
+ * Used to interact with mail capability, including opening and composing mail.
+ */
 var mail;
 (function (mail) {
+    /**
+     * Opens a mail message in the host.
+     *
+     * @param openMailItemParams - Object that specifies the ID of the mail message.
+     */
     function openMailItem(openMailItemParams) {
         return new Promise(function (resolve) {
             ensureInitialized(runtime, FrameContexts.content);
@@ -7422,6 +7581,12 @@ var mail;
         });
     }
     mail.openMailItem = openMailItem;
+    /**
+     * Compose a new email in the user's mailbox.
+     *
+     * @param composeMailParams - Object that specifies the type of mail item to compose and the details of the mail item.
+     *
+     */
     function composeMail(composeMailParams) {
         return new Promise(function (resolve) {
             ensureInitialized(runtime, FrameContexts.content);
@@ -7442,11 +7607,16 @@ var mail;
         return ensureInitialized(runtime) && runtime.supports.mail ? true : false;
     }
     mail.isSupported = isSupported;
+    /** Defines compose mail types. */
     var ComposeMailType;
     (function (ComposeMailType) {
+        /** Compose a new mail message. */
         ComposeMailType["New"] = "new";
+        /** Compose a reply to the sender of an existing mail message. */
         ComposeMailType["Reply"] = "reply";
+        /** Compose a reply to all recipients of an existing mail message. */
         ComposeMailType["ReplyAll"] = "replyAll";
+        /** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
         ComposeMailType["Forward"] = "forward";
     })(ComposeMailType = mail.ComposeMailType || (mail.ComposeMailType = {}));
 })(mail || (mail = {}));
@@ -7654,6 +7824,7 @@ var video;
      */
     var VideoFrameFormat;
     (function (VideoFrameFormat) {
+        /** Video format used for encoding and decoding YUV color data in video streaming and storage applications. */
         VideoFrameFormat[VideoFrameFormat["NV12"] = 0] = "NV12";
     })(VideoFrameFormat = video.VideoFrameFormat || (video.VideoFrameFormat = {}));
     /**
@@ -7897,7 +8068,12 @@ var search;
  */
 var sharing;
 (function (sharing) {
+    /** Type of message that can be sent or received by the sharing APIs */
     sharing.SharingAPIMessages = {
+        /**
+         * Share web content message.
+         * @internal
+         */
         shareWebContent: 'sharing.shareWebContent',
     };
     function shareWebContent(shareWebContentRequest, callback) {
@@ -8075,14 +8251,23 @@ var webStorage;
 
 
 
+/**
+ * Used to interact with call functionality, including starting calls with other users.
+ */
 var call;
 (function (call) {
+    /** Modalities that can be associated with a call. */
     var CallModalities;
     (function (CallModalities) {
+        /** Indicates that the modality is unknown or undefined. */
         CallModalities["Unknown"] = "unknown";
+        /** Indicates that the call includes audio. */
         CallModalities["Audio"] = "audio";
+        /** Indicates that the call includes video. */
         CallModalities["Video"] = "video";
+        /** Indicates that the call includes video-based screen sharing. */
         CallModalities["VideoBasedScreenSharing"] = "videoBasedScreenSharing";
+        /** Indicates that the call includes data sharing or messaging. */
         CallModalities["Data"] = "data";
     })(CallModalities = call.CallModalities || (call.CallModalities = {}));
     /**
@@ -8256,7 +8441,7 @@ function getContext(callback) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
+ * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: registerOnThemeChangeHandlerFunctionType): void} instead.
  *
  * Registers a handler for theme changes.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8268,7 +8453,7 @@ function registerOnThemeChangeHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
+ * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: registerFullScreenHandlerFunctionType): void} instead.
  *
  * Registers a handler for changes from or to full-screen view for a tab.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8280,7 +8465,7 @@ function registerFullScreenHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: callbackFunctionType): void} instead.
  *
  * Registers a handler for clicking the app button.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8292,7 +8477,7 @@ function registerAppButtonClickHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: callbackFunctionType): void} instead.
  *
  * Registers a handler for entering hover of the app button.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8304,7 +8489,7 @@ function registerAppButtonHoverEnterHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: callbackFunctionType): void} instead.
  *
  * Registers a handler for exiting hover of the app button.
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -8316,7 +8501,7 @@ function registerAppButtonHoverLeaveHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
+ * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: registerBackButtonHandlerFunctionType): void} instead.
  *
  * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
  * navigation stack should use this handler to navigate the user back within their frame. If an app finds
@@ -8342,7 +8527,7 @@ function registerOnLoadHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
+ * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: callbackFunctionType) => boolean): void} instead.
  *
  * @hidden
  * Registers a handler to be called before the page is unloaded.
@@ -8367,7 +8552,7 @@ function registerFocusEnterHandler(handler) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
+ * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: callbackFunctionType): void} instead.
  *
  * Registers a handler for when the user reconfigurated tab.
  *
@@ -8454,7 +8639,7 @@ function setFrameContext(frameContext) {
 }
 /**
  * @deprecated
- * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
+ * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: callbackFunctionType, validMessageOrigins?: string[],): void} instead.
  *
  * Initialize with FrameContext
  *
@@ -8473,9 +8658,6 @@ function initializeWithFrameContext(frameContext, callback, validMessageOrigins)
 
 
 
-/**
- * Navigation specific part of the SDK.
- */
 /**
  * @deprecated
  * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
@@ -8618,7 +8800,7 @@ var settings;
     settings.setSettings = setSettings;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
+     * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: registerOnSaveHandlerFunctionType): void} instead.
      *
      * Registers a handler for when the user attempts to save the settings. This handler should be used
      * to create or update the underlying resource powering the content.
@@ -8633,7 +8815,7 @@ var settings;
     settings.registerOnSaveHandler = registerOnSaveHandler;
     /**
      * @deprecated
-     * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
+     * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: registerOnRemoveHandlerFunctionType): void} instead.
      *
      * Registers a handler for user attempts to remove content. This handler should be used
      * to remove the underlying resource powering the content.
@@ -8843,6 +9025,7 @@ var ContainerState;
     ContainerState["notFound"] = "NotFound";
 })(ContainerState || (ContainerState = {}));
 /**
+ * @hidden
  * Live Share host implementation for O365 and Teams clients.
  *
  * @beta
@@ -8857,8 +9040,8 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.getFluidTenantInfo = function () {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             resolve(sendAndHandleSdkError('interactive.getFluidTenantInfo'));
         });
     };
@@ -8872,8 +9055,8 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.getFluidToken = function (containerId) {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             // eslint-disable-next-line strict-null-checks/all
             resolve(sendAndHandleSdkError('interactive.getFluidToken', containerId));
         });
@@ -8885,8 +9068,8 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.getFluidContainerId = function () {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             resolve(sendAndHandleSdkError('interactive.getFluidContainerId'));
         });
     };
@@ -8903,8 +9086,8 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.setFluidContainerId = function (containerId) {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             resolve(sendAndHandleSdkError('interactive.setFluidContainerId', containerId));
         });
     };
@@ -8915,8 +9098,8 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.getNtpTime = function () {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             resolve(sendAndHandleSdkError('interactive.getNtpTime'));
         });
     };
@@ -8930,8 +9113,8 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.registerClientId = function (clientId) {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             resolve(sendAndHandleSdkError('interactive.registerClientId', clientId));
         });
     };
@@ -8945,11 +9128,26 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.prototype.getClientRoles = function (clientId) {
+        ensureSupported();
         return new Promise(function (resolve) {
-            ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
             resolve(sendAndHandleSdkError('interactive.getClientRoles', clientId));
         });
     };
+    /**
+     * @hidden
+     * Returns the `IClientInfo` associated with a client ID.
+     *
+     * @param clientId The Client ID the message was received from.
+     * @returns The info for a given client. Returns `undefined` if the client ID hasn't been registered yet.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.getClientInfo = function (clientId) {
+        ensureSupported();
+        return new Promise(function (resolve) {
+            resolve(sendAndHandleSdkError('interactive.getClientInfo', clientId));
+        });
+    };
     /**
      * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
      *
@@ -8959,12 +9157,33 @@ var LiveShareHost = /** @class */ (function () {
      * @beta
      */
     LiveShareHost.create = function () {
-        ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel);
+        ensureSupported();
         return new LiveShareHost();
     };
     return LiveShareHost;
 }());
 
+/**
+ * @hidden
+ *
+ * Checks if the interactive capability is supported by the host
+ * @returns boolean to represent whether the interactive capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function isSupported() {
+    return ensureInitialized(runtime, FrameContexts.meetingStage, FrameContexts.sidePanel) && runtime.supports.interactive
+        ? true
+        : false;
+}
+function ensureSupported() {
+    if (!isSupported()) {
+        throw new Error('LiveShareHost Not supported');
+    }
+}
 
 ;// CONCATENATED MODULE: ./src/public/index.ts