useWaitingParticipants(params?): Object
useWaitingParticipants can also be used to set up optional callbacks for waiting-participant-added, waiting-participant-updated, and waiting-participant-removed events.
Parameters (optional)
An object with the following properties:Function
Callback for the
waiting-participant-added event.Function
Callback for the
waiting-participant-updated event.Function
Callback for the
waiting-participant-removed event.Return value
An object with the following properties:Object[]
Details waiting participants, see
waitingParticipants().Function
Can be used to admit entry to waiting participants. Accepts
'*' to admit all participants, or a string session_id to admit a specific participant. Returns a Promise that rejects if the update fails, for example when the given participant is no longer waiting.Function
Can be used to deny entry to waiting participants. Accepts
'*' to deny all participants, or a string session_id to deny a specific participant. Returns a Promise that rejects if the update fails, for example when the given participant is no longer waiting.