IFluidContainerInfo interface

  • Reference
Package:
@microsoft/live-share

Returned from LiveShareHost.get/setFluidContainerId() to specify the container mapping for the current Live Share session.

Properties

containerId

ID of the container to join for the meeting. Undefined if the container hasn't been created yet.
containerState

State of the containerId mapping.
retryAfter

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.
shouldCreate

If true, the local client should create the container and then save the created containers ID to the mapping service.

Property Details

containerId

ID of the container to join for the meeting. Undefined if the container hasn't been created yet.

containerId: undefined | string

Property Value

undefined | string

containerState

State of the containerId mapping.

containerState: ContainerState

Property Value

ContainerState

retryAfter

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

Property Value

number

shouldCreate

If true, the local client should create the container and then save the created containers ID to the mapping service.

shouldCreate: boolean

Property Value

boolean