Skip to content

Collaboration

Description of the collaboration field

interface CollaborationState {
    followedUserUuid: string
    collaborativeUsers: CollaborativeUser[]
}

followedUserUuid

Updated by: UI

UUID of the user whose camera is followed by the current user.

Data model

followedUserUuid: string

Examples

Follow a user

{
  "collaboration":{
    ...
    "followedUserUuid":"6d1f865a-3dfb-4475-b3ac-97565ad0a0c9"
    ...
}

Don't follow a user

{
  "collaboration":{
    ...
    "followedUserUuid":""
    ...
}

collaborativeUsers

Updated by: Player

Data model

interface CollaborativeUser {
    uuid: string
    name: string
    color: string
    avatarUrl: string
}

Operations done by the Player

When another user opens the same file, a Collaborative User is added to the list:

{
  "collaboration":{
    ...
    "collaborativeUsers":[
      {
        "avatarurl":"https://www.gravatar.com/avatar/534a",
        "color":"#2196F3",
        "name":"test",
        "uuid":"6d1f865a-3dfb-4475-b3ac-97565ad0a0c9"
      }
    ]
    ...
  }
}

When there's no other user on the same file, the list is empty:

{
  "collaboration":{
    ...
    "collaborativeUsers":[]
    ...
}


November 24, 2022 March 8, 2022