zoom_meeting_waiting_room

Zoom Meeting Waiting Room
Description:
  • Zoom Meeting Waiting Room
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function Callback event of notification that user joins the waiting room.
onWaitingRoomUserLeft function Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
onWaitingRoomPresetAudioStatusChanged function During the waiting room, this callback event will be triggered when host change audio status.
onWaitingRoomPresetVideoStatusChanged function During the waiting room, this callback event will be triggered when host change video status.
onCustomWaitingRoomDataUpdated function During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
onWaitingRoomUserNameChanged function Callback indicating that the name of a user in the waiting room has changed.
onWaitingRoomEntranceEnabled function Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Returns:
Type
ZoomMeetingWaitingRoom
Description:
  • Zoom Meeting Waiting Room
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function Callback event of notification that user joins the waiting room.
onWaitingRoomUserLeft function Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
onWaitingRoomPresetAudioStatusChanged function During the waiting room, this callback event will be triggered when host change audio status.
onWaitingRoomPresetVideoStatusChanged function During the waiting room, this callback event will be triggered when host change video status.
onCustomWaitingRoomDataUpdated function During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
onWaitingRoomUserNameChanged function Callback indicating that the name of a user in the waiting room has changed.
onWaitingRoomEntranceEnabled function Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Returns:
Type
ZoomMeetingWaitingRoom

Methods

(inner) AdmitAllToMeeting() → {Number}

Description:
  • Permit all of the users currently in the waiting room to join the meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AdmitAllToMeeting() → {Number}

Description:
  • Permit all of the users currently in the waiting room to join the meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AdmitToMeeting(userid) → {Number}

Description:
  • Permit the specified user to join the meeting.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AdmitToMeeting(userid) → {Number}

Description:
  • Permit the specified user to join the meeting.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CanExpelUser() → {Boolean}

Description:
  • Determine if a host or cohost can expel user(s) in the waiting room.
Source:
Returns:
True means that a host or cohost can expel user(s) in the waiting room. Otherwise they may not
Type
Boolean

(inner) CanExpelUser() → {Boolean}

Description:
  • Determine if a host or cohost can expel user(s) in the waiting room.
Source:
Returns:
True means that a host or cohost can expel user(s) in the waiting room. Otherwise they may not
Type
Boolean

(inner) CanRenameUser() → {Boolean}

Description:
  • Determine if the host or cohost can rename users in the waiting room.
Source:
Returns:
True means the host or cohost can rename users in the waiting room. Otherwise they can't.
Type
Boolean

(inner) CanRenameUser() → {Boolean}

Description:
  • Determine if the host or cohost can rename users in the waiting room.
Source:
Returns:
True means the host or cohost can rename users in the waiting room. Otherwise they can't.
Type
Boolean

(inner) EnableWaitingRoomOnEntry(bEnable) → {Number}

Description:
  • Set to enable the attendee to enter the waiting room when joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Number True indicates to enable to enter. False not.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) EnableWaitingRoomOnEntry(bEnable) → {Number}

Description:
  • Set to enable the attendee to enter the waiting room when joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Number True indicates to enable to enter. False not.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) ExpelUser(userid) → {Number}

Description:
  • Remove a specified user from the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of the user removed from the waiting room by a host or cohost.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) ExpelUser(userid) → {Number}

Description:
  • Remove a specified user from the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of the user removed from the waiting room by a host or cohost.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) GetWaitingRoomList() → {Array}

Description:
  • Get the list of attendees who are in the waiting room.
Source:
Returns:
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is null.
Type
Array

(inner) GetWaitingRoomList() → {Array}

Description:
  • Get the list of attendees who are in the waiting room.
Source:
Returns:
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is null.
Type
Array

(inner) GetWaitingRoomUserInfoByID(userid) → {Object}

Description:
  • Get the attendee information in the waiting room via user ID.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
Type
Object

(inner) GetWaitingRoomUserInfoByID(userid) → {Object}

Description:
  • Get the attendee information in the waiting room via user ID.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
Type
Object

(inner) Ignore() → {Number}

Description:
  • Ignore to GDownloadet the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Ignore() → {Number}

Description:
  • Ignore to GDownloadet the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) IsAudioEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on audio when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsAudioEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on audio when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsSupportWaitingRoom() → {Boolean}

Description:
  • Determine whether the current meeting supports the waiting room or not.
Source:
Returns:
True indicates to support.
Type
Boolean

(inner) IsSupportWaitingRoom() → {Boolean}

Description:
  • Determine whether the current meeting supports the waiting room or not.
Source:
Returns:
True indicates to support.
Type
Boolean

(inner) IsVideoEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on video when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsVideoEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on video when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsWaitingRoomOnEntryFlagOn() → {Boolean}

Description:
  • Determine if the attendee is enabled to enter the waiting room when joining the meeting.
Source:
Returns:
True indicates to enable to enter.
Type
Boolean

(inner) IsWaitingRoomOnEntryFlagOn() → {Boolean}

Description:
  • Determine if the attendee is enabled to enter the waiting room when joining the meeting.
Source:
Returns:
True indicates to enable to enter.
Type
Boolean

(inner) PutInWaitingRoom(userid) → {Number}

Description:
  • Enable the specified user to enter the waiting room.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) PutInWaitingRoom(userid) → {Number}

Description:
  • Enable the specified user to enter the waiting room.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RenameUser(userid, newName) → {Number}

Description:
  • Change a user's screen name in the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of users put into the waiting room by a host or cohost.
newName String The new user name.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RenameUser(userid, newName) → {Number}

Description:
  • Change a user's screen name in the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of users put into the waiting room by a host or cohost.
newName String The new user name.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RequestCustomWaitingRoomData() → {Number}

Description:
  • Get the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RequestCustomWaitingRoomData() → {Number}

Description:
  • Get the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Retry() → {Number}

Description:
  • Retry to Download the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Retry() → {Number}

Description:
  • Retry to Download the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnCustomWaitingRoomDataUpdatedCB(onCustomWaitingRoomDataUpdated) → {Boolean}

Description:
  • Set triggered RequestCustomWaitingRoomData callback.
Source:
Parameters:
Name Type Description
onCustomWaitingRoomDataUpdated function
Returns:
Type
Boolean

(inner) SetOnCustomWaitingRoomDataUpdatedCB(onCustomWaitingRoomDataUpdated) → {Boolean}

Description:
  • Set triggered RequestCustomWaitingRoomData callback.
Source:
Parameters:
Name Type Description
onCustomWaitingRoomDataUpdated function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomEntranceEnabledCB(onWaitingRoomEntranceEnabled) → {Boolean}

Description:
  • Set host or cohost enables or disables waiting room entrance callback.
Source:
Parameters:
Name Type Description
onWaitingRoomEntranceEnabled function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomEntranceEnabledCB(onWaitingRoomEntranceEnabled) → {Boolean}

Description:
  • Set host or cohost enables or disables waiting room entrance callback.
Source:
Parameters:
Name Type Description
onWaitingRoomEntranceEnabled function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetAudioStatusChangedCB(onWaitingRoomPresetAudioStatusChanged) → {Boolean}

Description:
  • Set host change audio status callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetAudioStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetAudioStatusChangedCB(onWaitingRoomPresetAudioStatusChanged) → {Boolean}

Description:
  • Set host change audio status callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetAudioStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetVideoStatusChangedCB(onWaitingRoomPresetVideoStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetVideoStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetVideoStatusChangedCB(onWaitingRoomPresetVideoStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetVideoStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserJoinCB(onWaitingRoomUserJoin) → {Boolean}

Description:
  • Set notification user joins the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserJoinCB(onWaitingRoomUserJoin) → {Boolean}

Description:
  • Set notification user joins the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserLeftCB(onWaitingRoomUserLeft) → {Boolean}

Description:
  • Set notification user leaves the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserLeft function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserLeftCB(onWaitingRoomUserLeft) → {Boolean}

Description:
  • Set notification user leaves the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserLeft function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserNameChangedCB(onWaitingRoomUserNameChanged) → {Boolean}

Description:
  • Set the name of a user in the waiting room has changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserNameChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserNameChangedCB(onWaitingRoomUserNameChanged) → {Boolean}

Description:
  • Set the name of a user in the waiting room has changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserNameChanged function
Returns:
Type
Boolean

Events

onCustomWaitingRoomDataUpdated

Description:
  • During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
Source:
Parameters:
Name Type Description
bData Object WaitingRoom Customize Data Info

onCustomWaitingRoomDataUpdated

Description:
  • During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
Source:
Parameters:
Name Type Description
bData Object WaitingRoom Customize Data Info

onWaitingRoomEntranceEnabled

Description:
  • Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Source:
Parameters:
Name Type Description
bIsEnabled Boolean True enables waiting room entrance, false means disables waiting room entrance.

onWaitingRoomEntranceEnabled

Description:
  • Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Source:
Parameters:
Name Type Description
bIsEnabled Boolean True enables waiting room entrance, false means disables waiting room entrance.

onWaitingRoomPresetAudioStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change audio status.
Source:
Parameters:
Name Type Description
bAudioCanTurnOn Boolean True means audio can be turned on. Otherwise not.

onWaitingRoomPresetAudioStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change audio status.
Source:
Parameters:
Name Type Description
bAudioCanTurnOn Boolean True means audio can be turned on. Otherwise not.

onWaitingRoomPresetVideoStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change video status.
Source:
Parameters:
Name Type Description
bVideoCanTurnOn Boolean True means video can be turned on. Otherwise not.

onWaitingRoomPresetVideoStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change video status.
Source:
Parameters:
Name Type Description
bVideoCanTurnOn Boolean True means video can be turned on. Otherwise not.

onWaitingRoomUserJoin

Description:
  • Callback event of notification that user joins the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who joins the waiting room.

onWaitingRoomUserJoin

Description:
  • Callback event of notification that user joins the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who joins the waiting room.

onWaitingRoomUserLeft

Description:
  • Callback event of notification that user leaves the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who leaves the waiting room.

onWaitingRoomUserLeft

Description:
  • Callback event of notification that user leaves the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who leaves the waiting room.

onWaitingRoomUserNameChanged

Description:
  • Callback indicating that the name of a user in the waiting room has changed.
Source:
Parameters:
Name Type Description
userID Number The ID of the user whose user name have has changed.
userName String The new user name.

onWaitingRoomUserNameChanged

Description:
  • Callback indicating that the name of a user in the waiting room has changed.
Source:
Parameters:
Name Type Description
userID Number The ID of the user whose user name have has changed.
userName String The new user name.
Zoom Meeting Waiting Room
Description:
  • Zoom Meeting Waiting Room
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function Callback event of notification that user joins the waiting room.
onWaitingRoomUserLeft function Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
onWaitingRoomPresetAudioStatusChanged function During the waiting room, this callback event will be triggered when host change audio status.
onWaitingRoomPresetVideoStatusChanged function During the waiting room, this callback event will be triggered when host change video status.
onCustomWaitingRoomDataUpdated function During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
onWaitingRoomUserNameChanged function Callback indicating that the name of a user in the waiting room has changed.
onWaitingRoomEntranceEnabled function Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Returns:
Type
ZoomMeetingWaitingRoom
Description:
  • Zoom Meeting Waiting Room
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function Callback event of notification that user joins the waiting room.
onWaitingRoomUserLeft function Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
onWaitingRoomPresetAudioStatusChanged function During the waiting room, this callback event will be triggered when host change audio status.
onWaitingRoomPresetVideoStatusChanged function During the waiting room, this callback event will be triggered when host change video status.
onCustomWaitingRoomDataUpdated function During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
onWaitingRoomUserNameChanged function Callback indicating that the name of a user in the waiting room has changed.
onWaitingRoomEntranceEnabled function Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Returns:
Type
ZoomMeetingWaitingRoom

Methods

(inner) AdmitAllToMeeting() → {Number}

Description:
  • Permit all of the users currently in the waiting room to join the meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AdmitAllToMeeting() → {Number}

Description:
  • Permit all of the users currently in the waiting room to join the meeting.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AdmitToMeeting(userid) → {Number}

Description:
  • Permit the specified user to join the meeting.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) AdmitToMeeting(userid) → {Number}

Description:
  • Permit the specified user to join the meeting.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CanExpelUser() → {Boolean}

Description:
  • Determine if a host or cohost can expel user(s) in the waiting room.
Source:
Returns:
True means that a host or cohost can expel user(s) in the waiting room. Otherwise they may not
Type
Boolean

(inner) CanExpelUser() → {Boolean}

Description:
  • Determine if a host or cohost can expel user(s) in the waiting room.
Source:
Returns:
True means that a host or cohost can expel user(s) in the waiting room. Otherwise they may not
Type
Boolean

(inner) CanRenameUser() → {Boolean}

Description:
  • Determine if the host or cohost can rename users in the waiting room.
Source:
Returns:
True means the host or cohost can rename users in the waiting room. Otherwise they can't.
Type
Boolean

(inner) CanRenameUser() → {Boolean}

Description:
  • Determine if the host or cohost can rename users in the waiting room.
Source:
Returns:
True means the host or cohost can rename users in the waiting room. Otherwise they can't.
Type
Boolean

(inner) EnableWaitingRoomOnEntry(bEnable) → {Number}

Description:
  • Set to enable the attendee to enter the waiting room when joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Number True indicates to enable to enter. False not.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) EnableWaitingRoomOnEntry(bEnable) → {Number}

Description:
  • Set to enable the attendee to enter the waiting room when joining the meeting.
Source:
Parameters:
Name Type Description
bEnable Number True indicates to enable to enter. False not.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) ExpelUser(userid) → {Number}

Description:
  • Remove a specified user from the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of the user removed from the waiting room by a host or cohost.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) ExpelUser(userid) → {Number}

Description:
  • Remove a specified user from the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of the user removed from the waiting room by a host or cohost.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) GetWaitingRoomList() → {Array}

Description:
  • Get the list of attendees who are in the waiting room.
Source:
Returns:
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is null.
Type
Array

(inner) GetWaitingRoomList() → {Array}

Description:
  • Get the list of attendees who are in the waiting room.
Source:
Returns:
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is null.
Type
Array

(inner) GetWaitingRoomUserInfoByID(userid) → {Object}

Description:
  • Get the attendee information in the waiting room via user ID.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
Type
Object

(inner) GetWaitingRoomUserInfoByID(userid) → {Object}

Description:
  • Get the attendee information in the waiting room via user ID.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
Type
Object

(inner) Ignore() → {Number}

Description:
  • Ignore to GDownloadet the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Ignore() → {Number}

Description:
  • Ignore to GDownloadet the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) IsAudioEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on audio when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsAudioEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on audio when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsSupportWaitingRoom() → {Boolean}

Description:
  • Determine whether the current meeting supports the waiting room or not.
Source:
Returns:
True indicates to support.
Type
Boolean

(inner) IsSupportWaitingRoom() → {Boolean}

Description:
  • Determine whether the current meeting supports the waiting room or not.
Source:
Returns:
True indicates to support.
Type
Boolean

(inner) IsVideoEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on video when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsVideoEnabledInWaitingRoom() → {Boolean}

Description:
  • Determine if the attendee is enabled to turn on video when joining the meeting.
Source:
Returns:
True indicates to enable to turn on.
Type
Boolean

(inner) IsWaitingRoomOnEntryFlagOn() → {Boolean}

Description:
  • Determine if the attendee is enabled to enter the waiting room when joining the meeting.
Source:
Returns:
True indicates to enable to enter.
Type
Boolean

(inner) IsWaitingRoomOnEntryFlagOn() → {Boolean}

Description:
  • Determine if the attendee is enabled to enter the waiting room when joining the meeting.
Source:
Returns:
True indicates to enable to enter.
Type
Boolean

(inner) PutInWaitingRoom(userid) → {Number}

Description:
  • Enable the specified user to enter the waiting room.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) PutInWaitingRoom(userid) → {Number}

Description:
  • Enable the specified user to enter the waiting room.
Source:
Parameters:
Name Type Description
userid Number Specifies the user ID.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RenameUser(userid, newName) → {Number}

Description:
  • Change a user's screen name in the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of users put into the waiting room by a host or cohost.
newName String The new user name.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RenameUser(userid, newName) → {Number}

Description:
  • Change a user's screen name in the waiting room.
Source:
Parameters:
Name Type Description
userid Number The ID of users put into the waiting room by a host or cohost.
newName String The new user name.
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RequestCustomWaitingRoomData() → {Number}

Description:
  • Get the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) RequestCustomWaitingRoomData() → {Number}

Description:
  • Get the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Retry() → {Number}

Description:
  • Retry to Download the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) Retry() → {Number}

Description:
  • Retry to Download the WaitingRoom CustomizeData information in the waiting room.
Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnCustomWaitingRoomDataUpdatedCB(onCustomWaitingRoomDataUpdated) → {Boolean}

Description:
  • Set triggered RequestCustomWaitingRoomData callback.
Source:
Parameters:
Name Type Description
onCustomWaitingRoomDataUpdated function
Returns:
Type
Boolean

(inner) SetOnCustomWaitingRoomDataUpdatedCB(onCustomWaitingRoomDataUpdated) → {Boolean}

Description:
  • Set triggered RequestCustomWaitingRoomData callback.
Source:
Parameters:
Name Type Description
onCustomWaitingRoomDataUpdated function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomEntranceEnabledCB(onWaitingRoomEntranceEnabled) → {Boolean}

Description:
  • Set host or cohost enables or disables waiting room entrance callback.
Source:
Parameters:
Name Type Description
onWaitingRoomEntranceEnabled function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomEntranceEnabledCB(onWaitingRoomEntranceEnabled) → {Boolean}

Description:
  • Set host or cohost enables or disables waiting room entrance callback.
Source:
Parameters:
Name Type Description
onWaitingRoomEntranceEnabled function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetAudioStatusChangedCB(onWaitingRoomPresetAudioStatusChanged) → {Boolean}

Description:
  • Set host change audio status callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetAudioStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetAudioStatusChangedCB(onWaitingRoomPresetAudioStatusChanged) → {Boolean}

Description:
  • Set host change audio status callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetAudioStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetVideoStatusChangedCB(onWaitingRoomPresetVideoStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetVideoStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomPresetVideoStatusChangedCB(onWaitingRoomPresetVideoStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomPresetVideoStatusChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserJoinCB(onWaitingRoomUserJoin) → {Boolean}

Description:
  • Set notification user joins the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserJoinCB(onWaitingRoomUserJoin) → {Boolean}

Description:
  • Set notification user joins the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserJoin function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserLeftCB(onWaitingRoomUserLeft) → {Boolean}

Description:
  • Set notification user leaves the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserLeft function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserLeftCB(onWaitingRoomUserLeft) → {Boolean}

Description:
  • Set notification user leaves the waiting room callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserLeft function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserNameChangedCB(onWaitingRoomUserNameChanged) → {Boolean}

Description:
  • Set the name of a user in the waiting room has changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserNameChanged function
Returns:
Type
Boolean

(inner) SetOnWaitingRoomUserNameChangedCB(onWaitingRoomUserNameChanged) → {Boolean}

Description:
  • Set the name of a user in the waiting room has changed callback.
Source:
Parameters:
Name Type Description
onWaitingRoomUserNameChanged function
Returns:
Type
Boolean

Events

onCustomWaitingRoomDataUpdated

Description:
  • During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
Source:
Parameters:
Name Type Description
bData Object WaitingRoom Customize Data Info

onCustomWaitingRoomDataUpdated

Description:
  • During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
Source:
Parameters:
Name Type Description
bData Object WaitingRoom Customize Data Info

onWaitingRoomEntranceEnabled

Description:
  • Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Source:
Parameters:
Name Type Description
bIsEnabled Boolean True enables waiting room entrance, false means disables waiting room entrance.

onWaitingRoomEntranceEnabled

Description:
  • Callback event will be triggered when host or cohost enables or disables waiting room entrance.
Source:
Parameters:
Name Type Description
bIsEnabled Boolean True enables waiting room entrance, false means disables waiting room entrance.

onWaitingRoomPresetAudioStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change audio status.
Source:
Parameters:
Name Type Description
bAudioCanTurnOn Boolean True means audio can be turned on. Otherwise not.

onWaitingRoomPresetAudioStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change audio status.
Source:
Parameters:
Name Type Description
bAudioCanTurnOn Boolean True means audio can be turned on. Otherwise not.

onWaitingRoomPresetVideoStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change video status.
Source:
Parameters:
Name Type Description
bVideoCanTurnOn Boolean True means video can be turned on. Otherwise not.

onWaitingRoomPresetVideoStatusChanged

Description:
  • During the waiting room, this callback event will be triggered when host change video status.
Source:
Parameters:
Name Type Description
bVideoCanTurnOn Boolean True means video can be turned on. Otherwise not.

onWaitingRoomUserJoin

Description:
  • Callback event of notification that user joins the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who joins the waiting room.

onWaitingRoomUserJoin

Description:
  • Callback event of notification that user joins the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who joins the waiting room.

onWaitingRoomUserLeft

Description:
  • Callback event of notification that user leaves the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who leaves the waiting room.

onWaitingRoomUserLeft

Description:
  • Callback event of notification that user leaves the waiting room.
Source:
Parameters:
Name Type Description
userID Number The ID of user who leaves the waiting room.

onWaitingRoomUserNameChanged

Description:
  • Callback indicating that the name of a user in the waiting room has changed.
Source:
Parameters:
Name Type Description
userID Number The ID of the user whose user name have has changed.
userName String The new user name.

onWaitingRoomUserNameChanged

Description:
  • Callback indicating that the name of a user in the waiting room has changed.
Source:
Parameters:
Name Type Description
userID Number The ID of the user whose user name have has changed.
userName String The new user name.