@microsoft/teams-js 2.4.2-beta.0 → 2.4.2-beta.1

package/dist/MicrosoftTeams.d.ts

@@ -3499,7 +3499,7 @@ export namespace app {
                     */
                 reason: FailedReason;
                 /**
-                    * A message that describes the failure
+                    * This property is currently unused.
                     */
                 message?: string;
         }
@@ -4073,8 +4073,10 @@ export namespace dialog {
                     */
                 err?: string;
                 /**
-                    * Result value that the dialog is submitted with using {@linkcode submit} function
-                    *
+                    * Value provided in the `result` parameter by the dialog when the {@linkcode submit} function
+                    * was called.
+                    * If the dialog was closed by the user without submitting (e.g., using a control in the corner
+                    * of the dialog), this value will be `undefined` here.
                     */
                 result?: string | object;
         }
@@ -6895,3 +6897,198 @@ export namespace tasks {
         function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
 }
 
+/**
+    * @hidden
+    * Allowed roles during a meeting.
+    *
+    * @beta
+    */
+export enum UserMeetingRole {
+        guest = "Guest",
+        attendee = "Attendee",
+        presenter = "Presenter",
+        organizer = "Organizer"
+}
+/**
+    * @hidden
+    * State of the current Live Share sessions backing fluid container.
+    *
+    * @beta
+    */
+export enum ContainerState {
+        /**
+            * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
+            * for the current Live Share session.
+            */
+        added = "Added",
+        /**
+            * A container mapping for the current Live Share Session already exists and should be used
+            * when joining the sessions Fluid container.
+            */
+        alreadyExists = "AlreadyExists",
+        /**
+            * The call to `LiveShareHost.setContainerId()` failed to create the container mapping due to
+            * another client having already set the container ID for the current Live Share session.
+            */
+        conflict = "Conflict",
+        /**
+            * A container mapping for the current Live Share session doesn't exist yet.
+            */
+        notFound = "NotFound"
+}
+/**
+    * @hidden
+    * Returned from `LiveShareHost.get/setFluidContainerId()` to specify the container mapping for the
+    * current Live Share session.
+    *
+    * @beta
+    */
+export interface IFluidContainerInfo {
+        /**
+            * State of the containerId mapping.
+            */
+        containerState: ContainerState;
+        /**
+            * ID of the container to join for the meeting. Undefined if the container hasn't been
+            * created yet.
+            */
+        containerId: string | undefined;
+        /**
+            * If true, the local client should create the container and then save the created containers
+            * ID to the mapping service.
+            */
+        shouldCreate: boolean;
+        /**
+            * If `containerId` is undefined and `shouldCreate` is false, the container isn't ready but
+            * another client is creating it. The local client should wait the specified amount of time and
+            * then ask for the container info again.
+            */
+        retryAfter: number;
+}
+/**
+    * @hidden
+    * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
+    * Live Share session.
+    *
+    * @beta
+    */
+export interface INtpTimeInfo {
+        /**
+            * ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
+            */
+        ntpTime: string;
+        /**
+            * Server time expressed as the number of milliseconds since the ECMAScript epoch.
+            */
+        ntpTimeInUTC: number;
+}
+/**
+    * @hidden
+    * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
+    * current Live Share session.
+    *
+    * @beta
+    */
+export interface IFluidTenantInfo {
+        /**
+            * The Fluid Tenant ID Live Share should use.
+            */
+        tenantId: string;
+        /**
+            * The Fluid service endpoint Live Share should use.
+            */
+        serviceEndpoint?: string;
+        /**
+            * @deprecated
+            * As of Fluid 1.0 this configuration information has been deprecated in favor of
+            * `serviceEndpoint`.
+            */
+        ordererEndpoint: string;
+        /**
+            * @deprecated
+            * As of Fluid 1.0 this configuration information has been deprecated in favor of
+            * `serviceEndpoint`.
+            */
+        storageEndpoint: string;
+}
+/**
+    * Live Share host implementation for O365 and Teams clients.
+    *
+    * @beta
+    */
+export class LiveShareHost {
+        /**
+            * @hidden
+            * Returns the Fluid Tenant connection info for user's current context.
+            *
+            * @beta
+            */
+        getFluidTenantInfo(): Promise<IFluidTenantInfo>;
+        /**
+            * @hidden
+            * Returns the fluid access token for mapped container Id.
+            *
+            * @param containerId Fluid's container Id for the request. Undefined for new containers.
+            * @returns token for connecting to Fluid's session.
+            *
+            * @beta
+            */
+        getFluidToken(containerId?: string): Promise<string>;
+        /**
+            * @hidden
+            * Returns the ID of the fluid container associated with the user's current context.
+            *
+            * @beta
+            */
+        getFluidContainerId(): Promise<IFluidContainerInfo>;
+        /**
+            * @hidden
+            * Sets the ID of the fluid container associated with the current context.
+            *
+            * @remarks
+            * If this returns false, the client should delete the container they created and then call
+            * `getFluidContainerId()` to get the ID of the container being used.
+            * @param containerId ID of the fluid container the client created.
+            * @returns A data structure with a `containerState` indicating the success or failure of the request.
+            *
+            * @beta
+            */
+        setFluidContainerId(containerId: string): Promise<IFluidContainerInfo>;
+        /**
+            * @hidden
+            * Returns the shared clock server's current time.
+            *
+            * @beta
+            */
+        getNtpTime(): Promise<INtpTimeInfo>;
+        /**
+            * @hidden
+            * Associates the fluid client ID with a set of user roles.
+            *
+            * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
+            * @returns The roles for the current user.
+            *
+            * @beta
+            */
+        registerClientId(clientId: string): Promise<UserMeetingRole[]>;
+        /**
+            * @hidden
+            * Returns the roles associated with a client ID.
+            *
+            * @param clientId The Client ID the message was received from.
+            * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
+            *
+            * @beta
+            */
+        getClientRoles(clientId: string): Promise<UserMeetingRole[] | undefined>;
+        /**
+            * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
+            *
+            * @remarks
+            * The application must first be initialized and may only be called from `meetingStage` or `sidePanel` contexts.
+            *
+            * @beta
+            */
+        static create(): LiveShareHost;
+}
+

package/dist/MicrosoftTeams.js

@@ -1046,17 +1046,20 @@ __webpack_require__.d(__webpack_exports__, {
   "ActionObjectType": () => (/* reexport */ ActionObjectType),
   "ChannelType": () => (/* reexport */ ChannelType),
   "ChildAppWindow": () => (/* reexport */ ChildAppWindow),
+  "ContainerState": () => (/* reexport */ ContainerState),
   "DialogDimension": () => (/* reexport */ DialogDimension),
   "ErrorCode": () => (/* reexport */ ErrorCode),
   "FileOpenPreference": () => (/* reexport */ FileOpenPreference),
   "FrameContexts": () => (/* reexport */ FrameContexts),
   "HostClientType": () => (/* reexport */ HostClientType),
   "HostName": () => (/* reexport */ HostName),
+  "LiveShareHost": () => (/* reexport */ LiveShareHost),
   "NotificationTypes": () => (/* reexport */ NotificationTypes),
   "ParentAppWindow": () => (/* reexport */ ParentAppWindow),
   "SecondaryM365ContentIdName": () => (/* reexport */ SecondaryM365ContentIdName),
   "TaskModuleDimension": () => (/* reexport */ TaskModuleDimension),
   "TeamType": () => (/* reexport */ TeamType),
+  "UserMeetingRole": () => (/* reexport */ UserMeetingRole),
   "UserSettingTypes": () => (/* reexport */ UserSettingTypes),
   "UserTeamRole": () => (/* reexport */ UserTeamRole),
   "ViewerActionTypes": () => (/* reexport */ ViewerActionTypes),
@@ -1130,7 +1133,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.4.2-beta.0";
+var version = "2.4.2-beta.1";
 
 ;// CONCATENATED MODULE: ./src/internal/globalVars.ts
 var GlobalVars = /** @class */ (function () {
@@ -8248,6 +8251,175 @@ var tasks;
     tasks.getDefaultSizeIfNotProvided = getDefaultSizeIfNotProvided;
 })(tasks || (tasks = {}));
 
+;// CONCATENATED MODULE: ./src/public/liveShareHost.ts
+
+
+
+/**
+ * @hidden
+ * Allowed roles during a meeting.
+ *
+ * @beta
+ */
+var UserMeetingRole;
+(function (UserMeetingRole) {
+    UserMeetingRole["guest"] = "Guest";
+    UserMeetingRole["attendee"] = "Attendee";
+    UserMeetingRole["presenter"] = "Presenter";
+    UserMeetingRole["organizer"] = "Organizer";
+})(UserMeetingRole || (UserMeetingRole = {}));
+/**
+ * @hidden
+ * State of the current Live Share sessions backing fluid container.
+ *
+ * @beta
+ */
+var ContainerState;
+(function (ContainerState) {
+    /**
+     * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
+     * for the current Live Share session.
+     */
+    ContainerState["added"] = "Added";
+    /**
+     * A container mapping for the current Live Share Session already exists and should be used
+     * when joining the sessions Fluid container.
+     */
+    ContainerState["alreadyExists"] = "AlreadyExists";
+    /**
+     * The call to `LiveShareHost.setContainerId()` failed to create the container mapping due to
+     * another client having already set the container ID for the current Live Share session.
+     */
+    ContainerState["conflict"] = "Conflict";
+    /**
+     * A container mapping for the current Live Share session doesn't exist yet.
+     */
+    ContainerState["notFound"] = "NotFound";
+})(ContainerState || (ContainerState = {}));
+/**
+ * Live Share host implementation for O365 and Teams clients.
+ *
+ * @beta
+ */
+var LiveShareHost = /** @class */ (function () {
+    function LiveShareHost() {
+    }
+    /**
+     * @hidden
+     * Returns the Fluid Tenant connection info for user's current context.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.getFluidTenantInfo = function () {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            resolve(sendAndHandleSdkError('interactive.getFluidTenantInfo'));
+        });
+    };
+    /**
+     * @hidden
+     * Returns the fluid access token for mapped container Id.
+     *
+     * @param containerId Fluid's container Id for the request. Undefined for new containers.
+     * @returns token for connecting to Fluid's session.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.getFluidToken = function (containerId) {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            // eslint-disable-next-line strict-null-checks/all
+            resolve(sendAndHandleSdkError('interactive.getFluidToken', containerId));
+        });
+    };
+    /**
+     * @hidden
+     * Returns the ID of the fluid container associated with the user's current context.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.getFluidContainerId = function () {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            resolve(sendAndHandleSdkError('interactive.getFluidContainerId'));
+        });
+    };
+    /**
+     * @hidden
+     * Sets the ID of the fluid container associated with the current context.
+     *
+     * @remarks
+     * If this returns false, the client should delete the container they created and then call
+     * `getFluidContainerId()` to get the ID of the container being used.
+     * @param containerId ID of the fluid container the client created.
+     * @returns A data structure with a `containerState` indicating the success or failure of the request.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.setFluidContainerId = function (containerId) {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            resolve(sendAndHandleSdkError('interactive.setFluidContainerId', containerId));
+        });
+    };
+    /**
+     * @hidden
+     * Returns the shared clock server's current time.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.getNtpTime = function () {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            resolve(sendAndHandleSdkError('interactive.getNtpTime'));
+        });
+    };
+    /**
+     * @hidden
+     * Associates the fluid client ID with a set of user roles.
+     *
+     * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
+     * @returns The roles for the current user.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.registerClientId = function (clientId) {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            resolve(sendAndHandleSdkError('interactive.registerClientId', clientId));
+        });
+    };
+    /**
+     * @hidden
+     * Returns the roles associated with a client ID.
+     *
+     * @param clientId The Client ID the message was received from.
+     * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
+     *
+     * @beta
+     */
+    LiveShareHost.prototype.getClientRoles = function (clientId) {
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+            resolve(sendAndHandleSdkError('interactive.getClientRoles', clientId));
+        });
+    };
+    /**
+     * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
+     *
+     * @remarks
+     * The application must first be initialized and may only be called from `meetingStage` or `sidePanel` contexts.
+     *
+     * @beta
+     */
+    LiveShareHost.create = function () {
+        ensureInitialized(FrameContexts.meetingStage, FrameContexts.sidePanel);
+        return new LiveShareHost();
+    };
+    return LiveShareHost;
+}());
+
+
 ;// CONCATENATED MODULE: ./src/public/index.ts
 
 
@@ -8280,6 +8452,7 @@ var tasks;
 
 
 
+