Mac SDK
Instance Methods | Protected Attributes | Properties | List of all members
ZoomSDKWaitingRoomController Class Reference
Inheritance diagram for ZoomSDKWaitingRoomController:

Instance Methods

(BOOL) - isSupportWaitingRoom
 Query if the meeting supports waiting room. More...
 
(BOOL) - isEnableWaitingRoomOnEntry
 Query if waiting room is enabled in current meeting. More...
 
(ZoomSDKError) - enableWaitingRoomOnEntry:
 Set to enable/disable waiting room. More...
 
(NSArray *) - getWaitRoomUserList
 Get the list of users in the waiting room. More...
 
(ZoomSDKUserInfo *) - getWaitingRoomUserInfo:
 Get the information of users in the waiting room. More...
 
(ZoomSDKError) - admitToMeeting:
 Admit user to join meeting. More...
 
(ZoomSDKError) - putIntoWaitingRoom:
 Put user into waiting room. More...
 

Protected Attributes

id< ZoomSDKWaitingRoomDelegate_delegate
 

Properties

id< ZoomSDKWaitingRoomDelegatedelegate
 

Method Documentation

◆ admitToMeeting:

- (ZoomSDKError) admitToMeeting: (unsigned int)  userid

Admit user to join meeting.

Parameters
useridThe ID of user who joins meeting.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableWaitingRoomOnEntry:

- (ZoomSDKError) enableWaitingRoomOnEntry: (BOOL)  enable

Set to enable/disable waiting room.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ getWaitingRoomUserInfo:

- (ZoomSDKUserInfo*) getWaitingRoomUserInfo: (unsigned int)  userid

Get the information of users in the waiting room.

Parameters
useridThe ID of user who is in the waiting room.
Returns
If the function succeeds, it will return the object of ZoomSDKUserInfo for the specified user.

◆ getWaitRoomUserList

- (NSArray*) getWaitRoomUserList

Get the list of users in the waiting room.

Returns
If the function succeeds, it will return a NSArray.

◆ isEnableWaitingRoomOnEntry

- (BOOL) isEnableWaitingRoomOnEntry

Query if waiting room is enabled in current meeting.

Returns
YES means enabled, otherwise not.

◆ isSupportWaitingRoom

- (BOOL) isSupportWaitingRoom

Query if the meeting supports waiting room.

Returns
YES means supported, otherwise not.

◆ putIntoWaitingRoom:

- (ZoomSDKError) putIntoWaitingRoom: (unsigned int)  userid

Put user into waiting room.

Parameters
useridThe ID of user who is put into waiting room by host/co-host.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

The documentation for this class was generated from the following file: