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

package/dist/MicrosoftTeams.d.ts

@@ -7673,6 +7673,19 @@ export interface IFluidTenantInfo {
         serviceEndpoint: string;
 }
 /**
+    * @hidden
+    * Returned from `LiveShareHost.getClientInfo()` to specify the client info for a
+    * particular client in a Live Share session.
+    *
+    * @beta
+    */
+export interface IClientInfo {
+        userId: string;
+        roles: UserMeetingRole[];
+        displayName?: string;
+}
+/**
+    * @hidden
     * Live Share host implementation for O365 and Teams clients.
     *
     * @beta
@@ -7742,6 +7755,16 @@ export class LiveShareHost {
             * @beta
             */
         getClientRoles(clientId: string): Promise<UserMeetingRole[] | undefined>;
+        /**
+            * @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
+            */
+        getClientInfo(clientId: string): Promise<IClientInfo | undefined>;
         /**
             * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
             *
@@ -7752,4 +7775,16 @@ export class LiveShareHost {
             */
         static create(): 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
+    */
+export function isSupported(): boolean;
 

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),
@@ -1797,6 +1798,7 @@ var teamsRuntimeConfig = {
             },
             update: {},
         },
+        interactive: {},
         logs: {},
         meetingRoom: {},
         menus: {},
@@ -1999,7 +2001,7 @@ var _minRuntimeConfigToUninitialize = {
 };
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.10.1";
+var version = "2.11.0-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -8843,6 +8845,7 @@ var ContainerState;
     ContainerState["notFound"] = "NotFound";
 })(ContainerState || (ContainerState = {}));
 /**
+ * @hidden
  * Live Share host implementation for O365 and Teams clients.
  *
  * @beta
@@ -8857,8 +8860,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 +8875,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 +8888,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 +8906,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 +8918,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 +8933,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 +8948,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 +8977,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