PresenceEvents Interface
Events from Presence.
To use, import via @fluidframework/presence/beta.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface PresenceEvents
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| workspaceActivated | Beta |
(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.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
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.