Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for hosting a Live Share session within a client like Teams.

Hierarchy

  • ILiveShareHost

Implemented by

Index

Methods

  • Queries the hosts role verification service for the roles associated with a given client ID.

    Parameters

    • clientId: string

      ID of teh client to lookup.

    Returns Promise<undefined | UserMeetingRole[]>

    An array of roles assigned to the queried client ID.

  • Returns the container mapping information for the current session.

    remarks

    Hosts are required to implement a container mapping service that stores the container ID for the current session.

    TODO: add creation protocol details

    Returns Promise<IFluidContainerInfo>

  • getFluidToken(containerId?: string): Promise<string>
  • Returns the Fluid access token to use for the current session.

    Parameters

    • Optional containerId: string

      Optional. ID of the container being joined. This will be undefined when creating a new container.

    Returns Promise<string>

  • Registers the local clients Fluid client ID with the hosts role verification service.

    remarks

    Hosts should expect this to be called anytime the Fluid clients underlying socket connects or reconnects.

    Parameters

    • clientId: string

      Unique ID assigned to the local Fluid client.

    Returns Promise<UserMeetingRole[]>

    An array of meeting roles assigned to the local user.

  • Attempts to save the ID of the Fluid container created to the hosts mapping service.

    remarks

    Hosts should return a containerState of "Added" if the mapping was successfully saved, otherwise a state of "Conflict" should be returned to indicate that another client has already saved a container ID for the current session.

    Parameters

    • containerId: string

      Id of the Fluid container that was created.

    Returns Promise<IFluidContainerInfo>

    Information indicating the success of mapping assignment.

Generated using TypeDoc