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

Properties​

Property Alerts Type Description
workspaceActivated Alpha (workspaceAddress: WorkspaceAddress, 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.

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.

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

Signature​

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

Type: (workspaceAddress: WorkspaceAddress, 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.