Home

Welcome to the communicate wiki!

Application events

Event: 'app'

Fired when a modular application on a client sends a message that needs to be delivered to a target or broadcast to all users. * message sent from client thru server to a target-user, room, or namespace

Event: 'hang-up'

Fired when the other peer has hung up the video call. Signaling messages are used to trade WebRTC signaling information during negotiations leading up to a video call. * message sent from client thru server to a target-user

Event: 'id'

Fired when the node/websocket server assigns a unique ClientID to the connection representing a user. * message sent from server to client upon WebSocket connection to server

Event: 'message'

Fired when a chat message is sent or received. * message sent from client to server. If a target is specified it will be directly sent else message will be broadcast to all users

Event: 'new-ice-candidate'

Fired when a new ICE candidate has been received. Signaling messages are used to trade WebRTC signaling information during negotiations leading up to a video call. * message sent from client thru server to a target-user

Event: 'rejectusername'

Fired when a change to username is rejected by the server. * message sent from server to client

Event: 'userlist'

Fired when client receives an updated user list. * message sent from server to client to in response to name changes, new users joining and user disconnecting

Event: 'username'

Fired when the client wants to change their username. Done at least once upon initial login to application after websocket has been established. * message sent from client to server

Event: 'video-answer'

Fired when Callee has answered the offer. Signaling messages are used to trade WebRTC signaling information during negotiations leading up to a video call. * message sent from client thru server to a target-user

Event: 'video-offer'

Fired when client initiates an invitation and offer to chat and/or whiteboard. Signaling messages are used to trade WebRTC signaling information during negotiations leading up to a video call. * message sent from client thru server to a target-user