Type of data object to share with clients.
The objects fluid type/name.
The objects fluid type factory.
Optional data object shared by the user.
Number of seconds without a presence update before a remote user is considered offline.
Number of seconds without a presence update before a remote user is considered offline.
Returns true if the object has been initialized.
The users current presence state.
Returns the ID of the local user.
Disposes of the object when its container is disposed of.
Enumerates each user the object is tracking presence for.
Function to call for each user.
Optional. Presence state to filter enumeration to.
Counts the number of users that the object is tracking presence for.
Optional. Presence state to filter count to.
Total number of other users we've seen or number of users with a given presence status.
Returns the current presence info for a specific user.
The ID of the user to retrieve.
The current presence information for the user if they've connected to the space.
Starts sharing presence information.
Optional. ID of the local user. Defaults to a GUID if not provided.
Optional. Custom data object to sshare. A deep copy of the data object is saved to avoid any accidental modifications.
Optional. Initial presence state. Defaults to PresenceState.online
.
Returns a snapshot of the current list of presence objects being tracked.
Array of presence objects.
Updates the users presence state and/or shared data object.
Optional. Presence state to change.
Optional. Data object to change. A deep copy of the data object is saved to avoid any future changes.
Generated using TypeDoc
Live fluid object that synchronizes presence information for the user with other clients.