@microsoft/teams-js 2.12.0 → 2.13.0-beta.0

package/dist/MicrosoftTeams.d.ts

@@ -7523,7 +7523,10 @@ export namespace call {
             * Starts a call with other users
             *
             * @param startCallParams - Parameters for the call
-            * @returns If the call is accepted
+            *
+            * @throws Error if call capability is not supported
+            * @throws Error if host notifies of a failed start call attempt in a legacy Teams environment
+            * @returns always true if the host notifies of a successful call inititation
             */
         function startCall(startCallParams: StartCallParams): Promise<boolean>;
         /**
@@ -8014,150 +8017,176 @@ export namespace tasks {
 }
 
 /**
-    * @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.
+    * APIs involving Live Share, a framework for building real-time collaborative apps.
+    * For more information, visit https://aka.ms/teamsliveshare
     *
-    * @beta
+    * @see LiveShareHost
     */
-export interface IFluidContainerInfo {
-        /**
-            * State of the containerId mapping.
-            */
-        containerState: ContainerState;
+export namespace liveShare {
         /**
-            * ID of the container to join for the meeting. Undefined if the container hasn't been
-            * created yet.
+            * @hidden
+            * The meeting roles of a user.
+            * Used in Live Share for its role verification feature.
+            * For more information, visit https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-live-share-capabilities?tabs=javascript#role-verification-for-live-data-structures
             */
-        containerId: string | undefined;
+        enum UserMeetingRole {
+                /**
+                    * Guest role.
+                    */
+                guest = "Guest",
+                /**
+                    * Attendee role.
+                    */
+                attendee = "Attendee",
+                /**
+                    * Presenter role.
+                    */
+                presenter = "Presenter",
+                /**
+                    * Organizer role.
+                    */
+                organizer = "Organizer"
+        }
         /**
-            * If true, the local client should create the container and then save the created containers
-            * ID to the mapping service.
+            * @hidden
+            * State of the current Live Share session's Fluid container.
+            * This is used internally by the `LiveShareClient` when joining a Live Share session.
             */
-        shouldCreate: boolean;
+        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.
+                    * This indicates to Live Share that a new container does not need be created.
+                    */
+                alreadyExists = "AlreadyExists",
+                /**
+                    * The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
+                    * This happens when another client has already set the container ID for the session.
+                    */
+                conflict = "Conflict",
+                /**
+                    * A container mapping for the current Live Share session does not yet exist.
+                    * This indicates to Live Share that a new container should be created.
+                    */
+                notFound = "NotFound"
+        }
         /**
-            * 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.
+            * @hidden
+            * Returned from `LiveShareHost.getFluidContainerId()` and `LiveShareHost.setFluidContainerId`.
+            * This response specifies the container mapping information for the current Live Share session.
             */
-        retryAfter: number;
-}
-/**
-    * @hidden
-    * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
-    * Live Share session.
-    *
-    * @beta
-    */
-export interface INtpTimeInfo {
+        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. In this case, the local client should wait the specified
+                    * amount of time before calling `LiveShareHost.getFluidContainerId()` again.
+                    */
+                retryAfter: number;
+        }
         /**
-            * ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
+            * @hidden
+            * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
+            * Live Share session.
             */
-        ntpTime: string;
+        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;
+        }
         /**
-            * Server time expressed as the number of milliseconds since the ECMAScript epoch.
+            * @hidden
+            * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
+            * current Live Share session.
             */
-        ntpTimeInUTC: number;
-}
-/**
-    * @hidden
-    * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
-    * current Live Share session.
-    *
-    * @beta
-    */
-export interface IFluidTenantInfo {
+        interface IFluidTenantInfo {
+                /**
+                    * The Fluid Tenant ID Live Share should use.
+                    */
+                tenantId: string;
+                /**
+                    * The Fluid service endpoint Live Share should use.
+                    */
+                serviceEndpoint: string;
+        }
         /**
-            * The Fluid Tenant ID Live Share should use.
+            * @hidden
+            * Returned from `LiveShareHost.getClientInfo()` to specify the client info for a
+            * particular client in a Live Share session.
             */
-        tenantId: string;
+        interface IClientInfo {
+                /**
+                    * The host user's `userId` associated with a given `clientId`
+                    */
+                userId: string;
+                /**
+                    * User's meeting roles associated with a given `clientId`
+                    */
+                roles: UserMeetingRole[];
+                /**
+                    * The user's display name associated with a given `clientId`.
+                    * If this returns as `undefined`, the user may need to update their host client.
+                    */
+                displayName?: string;
+        }
         /**
-            * The Fluid service endpoint Live Share should use.
+            * 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
             */
-        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;
+        function isSupported(): boolean;
 }
 /**
-    * @hidden
-    * Live Share host implementation for O365 and Teams clients.
+    * Live Share host implementation for connecting to real-time collaborative sessions.
+    * Designed for use with the `LiveShareClient` class in the `@microsoft/live-share` package.
+    * Learn more at https://aka.ms/teamsliveshare
     *
-    * @beta
+    * @remarks
+    * The `LiveShareClient` class from Live Share uses the hidden API's to join/manage the session.
+    * To create a new `LiveShareHost` instance use the static `LiveShareHost.create()` function.
     */
 export class LiveShareHost {
         /**
             * @hidden
             * Returns the Fluid Tenant connection info for user's current context.
-            *
-            * @beta
             */
-        getFluidTenantInfo(): Promise<IFluidTenantInfo>;
+        getFluidTenantInfo(): Promise<liveShare.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>;
+        getFluidContainerId(): Promise<liveShare.IFluidContainerInfo>;
         /**
             * @hidden
             * Sets the ID of the fluid container associated with the current context.
@@ -8167,69 +8196,47 @@ export class LiveShareHost {
             * `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>;
+        setFluidContainerId(containerId: string): Promise<liveShare.IFluidContainerInfo>;
         /**
             * @hidden
             * Returns the shared clock server's current time.
-            *
-            * @beta
             */
-        getNtpTime(): Promise<INtpTimeInfo>;
+        getNtpTime(): Promise<liveShare.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[]>;
+        registerClientId(clientId: string): Promise<liveShare.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>;
+        getClientRoles(clientId: string): Promise<liveShare.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>;
+        getClientInfo(clientId: string): Promise<liveShare.IClientInfo | undefined>;
         /**
-            * Returns a host instance for the client that can be passed to the `LiveShareClient` class.
+            * Factories a new `LiveShareHost` instance for use with the `LiveShareClient` class
+            * in the `@microsoft/live-share` package.
             *
             * @remarks
-            * The application must first be initialized and may only be called from `meetingStage` or `sidePanel` contexts.
-            *
-            * @beta
+            * `app.initialize()` must first be called before using this API.
+            * This API can only be called from `meetingStage` or `sidePanel` contexts.
             */
         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;
 
 /**
     * @hidden