Ara
Download

Search or run a command

Jump to a section or open an Ara link.

Protocol method · collab

collab.join

Join collaboration: this connection gets presence, claims, op and conflict notifications; returns everyone's state (and a snapshot on request).

  • Scope: read
  • Service: collab

Params

ParamRequiredDescription
sessionyesSession handle from session.begin.
nameDisplay name (Mia); default: the author's name.
colorAvatar colour #rrggbb; default: the next palette colour.
snapshotAlso return a snapshot of every document (late join of a replica).
eventsNotification methods to receive; absent receives all collaboration events.