Skip to main content

Function: roomLeave()

function roomLeave(request, context): Promise<void>;

Defined in: functions/events.ts:142

room:leave - Triggered when a user leaves the room

This callback fires when a user requests to leave the room they are in. Notifies other members in the room the that user has left. If a user is in a waiting room and leaves, then their userRoom will be deleted. They will need to request approval to join the room again.

Parameters

ParameterTypeDescription
requestSocketIODataTriggerThe SocketIODataTrigger
contextInvocationContextThe Invocation Context (metadata)

Returns

Promise<void>