Skip to main content
User presence lets iOS and Android apps read whether specific users are currently online. Use it for online badges, visible member lists, or a lightweight “who is online” snapshot.
The current TypeScript and Flutter SDKs in this checkout do not expose a user presence repository. Use the iOS and Android snippets below only for those platforms.

Platform Surface

Parameters

User Presence Object

The SDK limits active presence syncing to 20 user IDs at a time. Unsync users when their row, card, or profile preview is no longer visible.

Read User Presence

Fetch presence for known users as a one-shot read.

Sync User Presence

Sync user presence while users are visible, then unsync them when the UI no longer needs updates.

Read Online Users Count And Snapshot

Use the count for a network-wide online total. Use the snapshot when you need actual user objects at the time of the query.

Best Practices

Other users can only see the current user as online if the app enables presence and starts the current user’s heartbeat. See Heartbeat Sync.
Bind syncUserPresence to visible UI rows, cells, or cards. Call unsyncUserPresence during cell reuse, unmount, or screen dismissal.
getOnlineUsersSnapshot is a point-in-time read. For live online badges, sync specific visible users instead.

Channel Presence

Show whether any other member of a conversation channel is online.

Heartbeat Sync

Mark the current user as online with the SDK heartbeat.