Skip to content
Console
On this page

Realtime members

A Realtime Member is one client present in a channel: connected with a token that names its client id, entered, and not yet left.

A Realtime Member is one client present in a channel: connected with a token that names its client id, entered, and not yet left.

Service Sylphx Events · Resource type events.sylphx.com/RealtimeMember · Name pattern orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}/realtime_members/{realtime_member} · Shape record

Fields

FieldTypeWhat it is
namestring…/realtime_channels/{realtime_channel}/realtime_members/{realtime_member}.
uidstringrtb_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
client_idstringThe client id its token names. Output only.
datavalueThe member's presence data (set at enter, changed by an update). Output only.
enter_timetimestampWhen the member entered. Output only.
connection_countint32Open connections of this client in the channel. Output only.
joinedboolPersistent Chat membership, independent of online connections. Output only.
last_read_cursorstringLast acknowledged stream cursor; updates never move backwards. Output only.
unread_countint64Unread visible Chat messages from other members, excluding blocked senders. Output only.
mutedboolSuppress this conversation's notification intents. Output only.
rolestringMember or moderator, assigned by the tenant backend. Output only.
pinnedboolThis channel is an official, verified support conversation. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets one client present in a channel.
GETlistLists the clients present in a channel now.
POSTreadAdvances a member read cursor monotonically and sets mute.

get

Gets one client present in a channel.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members/realtime-member · scope events:read · effect read · Request, response and examples

list

Lists the clients present in a channel now.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members · scope events:read · effect read · paginated · Request, response and examples

read

Advances a member read cursor monotonically and sets mute.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_members/realtime-member:read · scope events:write · effect write · Request, response and examples