Nurama Developers
Events

Emit collab:cursor-move

Remote cursor position update (percentage coordinates).

client → server on the collab channel. Socket.IO event name: collab:cursor-move.

Remote cursor position update (percentage coordinates).

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.

Payload: collab:cursor-move

Payload of the 'collab:cursor-move' socket event.

PropertyTypeRequiredDescription
xnumbernoClient supplied X position as a percentage of the asset area.
ynumbernoClient supplied Y position as a percentage of the asset area.
visiblebooleannoClient supplied visibility flag.
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