ILiveShareClientOptions interface

Package:

@microsoft/live-share

Options used to configure the LiveShareClient class.

Properties

canSendBackgroundUpdates	Optional. Setting for whether LiveDataObject instances using LiveObjectSynchronizer can send background updates. Default value is true.
connection	Optional. Configuration to use when connecting to a custom Azure Fluid Relay instance.
logger	Optional. A logger instance to receive diagnostic messages.
roleVerifier	Optional. Custom role verifier to use.
timestampProvider	Optional. Custom timestamp provider to use.

Property Details

canSendBackgroundUpdates

Optional. Setting for whether LiveDataObject instances using LiveObjectSynchronizer can send background updates. Default value is true.

canSendBackgroundUpdates?: boolean

Property Value

boolean

Remarks

This is useful for scenarios where there are a large number of participants in a session, since service performance degrades as more socket connections are opened. Intended for use when a small number of users are intended to be "in control", such as the LiveFollowMode class's startPresenting() feature. There should always be at least one user in the session that has canSendBackgroundUpdates set to true. Set to true when the user is eligible to send background updates (e.g., "in control"), or false when that user is not in control. This setting will not prevent the local user from explicitly changing the state of objects using LiveObjectSynchronizer, such as .set() in LiveState. Impacts background updates of LiveState, LivePresence, LiveTimer, and LiveFollowMode.

connection

Optional. Configuration to use when connecting to a custom Azure Fluid Relay instance.

connection?: AzureRemoteConnectionConfig | AzureLocalConnectionConfig

Property Value

AzureRemoteConnectionConfig | AzureLocalConnectionConfig

logger

Optional. A logger instance to receive diagnostic messages.

logger?: ITelemetryBaseLogger

Property Value

ITelemetryBaseLogger

roleVerifier

Optional. Custom role verifier to use.

roleVerifier?: IRoleVerifier

Property Value

IRoleVerifier

timestampProvider

Optional. Custom timestamp provider to use.

timestampProvider?: ITimestampProvider

Property Value

ITimestampProvider