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
| Param | Required | Description |
|---|---|---|
session | yes | Session handle from session.begin. |
name | Display name (Mia); default: the author's name. | |
color | Avatar colour #rrggbb; default: the next palette colour. | |
snapshot | Also return a snapshot of every document (late join of a replica). | |
events | Notification methods to receive; absent receives all collaboration events. |