Class ModeratorWaitingRoomService

events

isWaitingRoomCapable

• get isWaitingRoomCapable(): boolean

• It checks a meeting's settings and returns if it can support waiting room functionality.

  Returns boolean

isWaitingRoomEnabled

• get isWaitingRoomEnabled(): boolean

• It returns if waiting room functionality is turned on for a meeting.

  Returns boolean

waitingRoomParticipants

• get waitingRoomParticipants(): Error | WaitingRoomParticipant[]

• It returns a list of participants which are currently in the waiting room.

  Returns Error | WaitingRoomParticipant[]

admitAll

• admitAll(): Promise<AdmitAllWrResponse>

• Admit all participants in the current meeting from the waiting room.

  Returns Promise<AdmitAllWrResponse>

admitParticipant

• admitParticipant(waitingRoomParticipant): Promise<AdmitParticipantWrResponse>

• Admit participant in the current meeting from the waiting room.

  Parameters

  • waitingRoomParticipant: WaitingRoomParticipant

  Returns Promise<AdmitParticipantWrResponse>

demote

• demote(participant): Promise<DemoteParticipantWrResponse>

• Demote participants in the current meeting from the waiting room.

  Parameters

  • participant: Participant

  Returns Promise<DemoteParticipantWrResponse>

denyAll

• denyAll(): Promise<DenyAllWrResponse>

• Deny all participants in the current meeting from the waiting room.

  Returns Promise<DenyAllWrResponse>

denyParticipant

• denyParticipant(waitingRoomParticipant): Promise<DenyParticipantWrResponse>

• Deny participant in the current meeting from the waiting room.

  Parameters

  • waitingRoomParticipant: WaitingRoomParticipant

  Returns Promise<DenyParticipantWrResponse>

observe

• observe(property, callback): void

• Allows observing changes to properties. Provide the property which you are interested in and a callback. Whenever the property value changes, you will be notified via the callback.

  Usage:

  Example

  sdk.meetingService.moderatorWaitingRoomService.observe("isWaitingRoomEnabled", function() {
       console.info("isWaitingRoomEnabled changed to : ", sdk.meetingService.moderatorWaitingRoomService.isWaitingRoomEnabled)
  });
  Copy

  Parameters

  • property: keyof ModeratorWaitingRoomService

    The name of the property to observe for changes.

  • callback: (() => void)

    on change event for the property.

    • • (): void

      • Returns void

  Returns void

setWaitingRoomEnabled

• setWaitingRoomEnabled(enabled): Promise<ToggleWaitingRoomResponse>

• Enables/disables waiting room.

  Parameters

  • enabled: any

  Returns Promise<ToggleWaitingRoomResponse>