updateWaitingParticipant()

updateWaitingParticipant(sessionId, {updates})

Compatibility:
Prebuilt
Custom

Applies the specified {updates} to a waiting participant. Specifying an id that does not correspond to a waiting participant will result in an error.

Possible updates include:

  • grantRequestedAccess: true | false: grants or denies a waiting participant the access they've requested

Once a waiting participant has been granted the access they've requested, they will be removed from waitingParticipants(), following a waiting-participant-removed event.

Returns a Promise that resolves to {id}, where id is the ID of the updated waiting participant.