Skip to main content

Function: roomRequest()

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

Defined in: functions/events.ts:202

room:request - Triggered when a user requests to join a room

This callback fires when a user requests to join a specific room Supplied data from client should equal: { roomId: theRoomUUID }

If the user is already approved for the requested rooom, join events and add the socket to the room. If not approved, dispatch a room:wait event.

Parameters

ParameterTypeDescription
requestSocketIODataTriggerThe SocketIODataTrigger
contextInvocationContextThe Invocation Context (metadata)

Returns

Promise<void>