Skip to main content

PresenceEvents Interface

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

For more information about our API support guarantees, see here.

Signature​

/** @sealed */
export interface PresenceEvents

Events​

Property Alerts Type Description
attendeeDisconnected Alpha (attendee: ISessionClient) => void Raised when client appears disconnected from session.
attendeeJoined Alpha (attendee: ISessionClient) => void Raised when new client joins session.

Properties​

Property Alerts Type Description
workspaceActivated Alpha (workspaceAddress: PresenceWorkspaceAddress, type: "States" | "Notifications" | "Unknown") => void

Raised when a workspace is activated within the session.

"Activated" means that a workspace is being used by a client and this client is seeing information for the first time.

Event Details​

attendeeDisconnected​

Raised when client appears disconnected from session.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

For more information about our API support guarantees, see here.

Signature​

attendeeDisconnected: (attendee: ISessionClient) => void;

Type: (attendee: ISessionClient) => void

attendeeJoined​

Raised when new client joins session.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

For more information about our API support guarantees, see here.

Signature​

attendeeJoined: (attendee: ISessionClient) => void;

Type: (attendee: ISessionClient) => void

Property Details​

workspaceActivated​

Raised when a workspace is activated within the session.

"Activated" means that a workspace is being used by a client and this client is seeing information for the first time.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

For more information about our API support guarantees, see here.

Signature​

workspaceActivated: (workspaceAddress: PresenceWorkspaceAddress, type: "States" | "Notifications" | "Unknown") => void;

Type: (workspaceAddress: PresenceWorkspaceAddress, type: "States" | "Notifications" | "Unknown") => void

Remarks​

Local workspaces may be passively acquired/registered when this event is raised. For a notifications workspace, that lazy registration must be done before the event handler returns to ensure no notifications are missed.