@microsoft/live-share package

Classes

EphemeralEvent

Ephemeral fluid object that broadcasts an event to other clients and a set of static event related helpers.

remarks

Applications should call on('received', (evt, local) => {}) to listen for local events sent and remote events received. Events aren't guaranteed to be delivered so you should limit their use to sending events you're ok with potentially being missed. Reactions are a good use case for EphemeralEvents. Use something like the EphemeralState class when syncing state.

EphemeralEventScope

Object responsible for sending and receiving ephemeral events.

EphemeralEventSource

Broadcasts ephemeral events to all clients and can be received by an EphemeralEventTarget.

EphemeralEventTarget

Receives events broadcast by an EphemeralEventSource.

EphemeralEventTimer

Periodically broadcasts an event to listening EphemeralEventTarget instances.

EphemeralObjectSynchronizer

Synchronizes the underlying state of an ephemeral object with all of the other instances of the object connected to the same container.

EphemeralPresence

Ephemeral fluid object that synchronizes presence information for the user with other clients.

EphemeralPresenceUser

A use that presence is being tracked for.

EphemeralState

Ephemeral fluid object that synchronizes a named state and optional data value across clients.

EphemeralTelemetryLogger

Wraps the configured logger for the runtime and ensures that certain mandatory properties are included on outgoing telemetry events.

TeamsFluidClient

Client used to connect to fluid containers within a Microsoft Teams context.

Interfaces

IEphemeralEventEvents

Event typings for EphemeralEvent class.

IRuntimeSignaler

Duck type of something that provides the expected signalling functionality: A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals

IContainerRuntimeSignaler

Duck type of something that provides the expected signalling functionality at the container level.

IEphemeralPresenceEvents

Event typings for EphemeralPresence class.

IEphemeralStateEvents

Event typings for EphemeralState class.

IEphemeralTelemetryProperties

Properties included on all events sent by EphemeralTelemetryLogger.

IEphemeralTimerEvents
ITeamsFluidClientOptions

Options used to configure the TeamsFluidClient class.

IEphemeralEvent

Base interface for all ephemeral events.

IEvent

Base interface for all event objects.

Type Aliases

EphemeralEventListener

Ephemeral event callback.

GetSynchronizationState

Callback function used to the get the current state of an ephemeral object that's being synchronized.

UpdateSynchronizationState

Callback function used to the receive the state update sent by a remote ephemeral object.

OutgoingEphemeralEvent

Removes the base properties from an event that derives from IEphemeralEvent.

Enums

EphemeralEventEvents

Events supported by EphemeralEvent object.

EphemeralPresenceEvents

Events supported by EphemeralPresence object.

PresenceState

List of possible presence states.

EphemeralStateEvents

Events supported by [EphemeralState` object.

UserMeetingRole

Allowed roles during a meeting.