Class Client

activate activates this client. That is, it registers itself to the server and receives a unique ID from the server. The given ID is used to distinguish different clients.

attach attaches a Document or Channel to this client. Overloaded to support both types.

attach attaches the given channel to this client. The channel is registered locally and the server is notified on the next RefreshChannel heartbeat.

attachChannel attaches the given channel to this client. The channel is registered locally and the server is notified on the next RefreshChannel heartbeat.

broadcast broadcasts the given payload to the given topic.

changeSyncMode changes the synchronization mode of the given document.

changeSyncMode changes the synchronization mode of the given channel.

createRevision creates a new revision for the given document.

deactivate deactivates this client.

detach detaches a Document or Channel from this client. Overloaded to support both types.

detach detaches the given channel from this client. The detach is a local cleanup; the server reclaims the session via TTL when heartbeats stop.

detachChannel detaches the given channel from this client. The detach is a local cleanup; the server reclaims the session via TTL when heartbeats stop.

getActorID returns the actor stamped into this client's document changes. On a server that supports stable actors it is the stable actor derived from the project and client key (ActivateClientResponse.actorId); otherwise it falls back to the per-session id. This is the actor a version vector is keyed by, so tests and callers that reason about change authorship or GC must use this, not getID.

getCondition returns the condition of this client.

getID returns the per-session id of this client. It is the wire clientId used for RPC routing, not the actor stamped into document changes. Use getActorID for the change author.

getKey returns a key of client.

getRevision retrieves a specific revision by its ID with full snapshot data.

getStatus returns the status of this client.

has checks if the given resource is attached to this client.

isActive checks if the client is active.

listRevisions lists all revisions for the given document.

peekChannel reads the current session count of a channel without creating a session on the server. Use this when the caller only needs to display the count (e.g. "N people writing") without contributing to it and without receiving broadcasts.

Unlike attach({ readOnly: true }), this does not occupy a Session entry on the server, does not generate heartbeat RPCs, and does not subscribe to channel events. Polling is the caller's responsibility.

remove removes the given document.

restoreRevision restores the document to the given revision.

sync pushes local changes of the attached documents to the server and receives changes of the remote replica from the server then apply them to local documents.

For Channel in manual mode, it refreshes the TTL by sending a heartbeat.

sync refreshes the TTL of the given channel by sending a heartbeat. This is used for manual mode channel.