Nurama Developers
Events

Emit collab:leave

A user left the collab session (explicit collab:leave from the client or socket disconnect).

client → server on the collab channel. Socket.IO event name: collab:leave.

A user left the collab session (explicit collab:leave from the client or socket disconnect).

Client -> server -> all other sockets in the same /chat/{chatId} namespace. The server spreads the client payload and appends the authenticated user identity (userId, displayName, color, avatarUrl), the annotationColor assigned on collab:join and a timestamp; client supplied values for those keys are overwritten. On disconnect the server emits it on behalf of the leaving socket; if they were the presenter a collab:presenter-assign (reason transfer-on-leave) follows.

Payload: collab:leave

Payload of the 'collab:leave' socket event.

PropertyTypeRequiredDescription
userIdstringnoAuthenticated user ID (server supplied, cannot be spoofed).
displayNamestring | nullnoDisplay name (falls back to first + last name).
colorstring | nullnoThe user's profile colour.
avatarUrlstring | nullnokeyPath of the user's avatar thumbnail file, if any.
annotationColorstringnoAnnotation colour assigned to this user for the collab session.
timestampintegernoServer time in milliseconds since epoch when the event was relayed.

On this page