ColabEventMap

interface ColabEventMap {
  change: ColabChangeEvent;
  'cnl:config': { config: ColabConfig; senderId: string };
  'cnl:create': { config: ColabConfig; senderId: string };
  'cnl:delete': { reason?: string; senderId: string };
  presence: ColabPresenceEvent;
  'user:add': { users: User[] };
  'user:del': { senderId: string; users: string[] };
  'user:join': { user: User };
  'user:left': { userId: string };
  'user:mod': { senderId: string; users: User[] };
}

index

properties

Properties

change

state changed

ColabChangeEvent

cnl:config

config updated

{ config: ColabConfig; senderId: string;  }

cnl:create

user created channel, event sent to initial users in channel to join call

{ config: ColabConfig; senderId: string;  }

cnl:delete

channel deleted

{ reason?: string; senderId: string;  }

presence

user presence events

ColabPresenceEvent

user:add

users were added to call

{ users: User[];  }

user:del

call user delete

{ senderId: string; users: string[];  }

user:join

a user joined call, may not have published tracks yet

{ user: User;  }

user:left

a user left call

{ userId: string;  }

user:mod

user moderated

{ senderId: string; users: User[];  }