Use this element to enable real-time presence tracking in your Bubble app.
State | Type | Description |
---|---|---|
others | Text (list) | Other users in the room. Empty when no room is currently synced. |
Room ID | Text | The room where this element is currently monitoring presence. |
Everyone | Text (list) | All users currently in the room, including the local user. |
User ID | Text | The Liveblocks user ID for the current user. |
Lost Connection | Text | A special event that triggers when a previously connected Liveblocks client loses connection. The possible statuses are: lost, restored, and failed. |
Error | Yes/No | Displays the error message if the room is currently experiencing an error. |
Error Message | Text | Displays the error message if an error occurs in the room. |
Error Code | Number | Displays the error status code if the room is currently experiencing an error. |
Event | Description |
---|---|
Lost Connection | Triggers when a lost connection event occurs. |
error | Triggers when an error occurs in the element. |
New Room ID | Triggers when the room ID changes while in the room. |
Event | Description |
---|---|
Broadcast event | Triggers when a new broadcast event occurs. |
Parameter | Type | Description |
---|---|---|
ID Token | Text | The user’s ID token. Ensure the user is authorized first using the ‘Liveblocks - Authorize User’ action. |
Throttle | Number | A number between 16 and 1000 milliseconds that determines how frequently presence updates are sent. |
Lost Connection Timeout | Number | After a user disconnects, the time in milliseconds before a “lost-connection” event is fired. Learn more |
Parameter | Type | Description |
---|---|---|
roomId | Text | The ID of the room to be joined. |
userId | Text | The unique ID of the local user joining the room. |
Enable position | Yes/No | An optional advanced parameter.Enable this parameter to allow live movement tracking of the user on the page. |
HTML ID prefix | Text | An optional advanced parameter. Add an HTML ID prefix so the plugin knows which elements to track. |
hideDefaultCursor | Yes/NO | Enable this option to hide the default browser cursor |
Field | Type | Description |
---|---|---|
Type | Text | The type of event being broadcasted. |
Message | Text | The message payload that accompanies the event. |