ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IMeetingWaitingRoomController Class Referenceabstract

Meeting waiting room controller interface. More...

#include <meeting_waiting_room_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingWaitingRoomEvent *pEvent)=0
 Set meeting waiting room callback event handler. More...
 
virtual bool IsSupportWaitingRoom ()=0
 Determine whether the current meeting supports the waiting room or not. More...
 
virtual bool IsWaitingRoomOnEntryFlagOn ()=0
 Determine if the attendee is enabled to enter the waiting room when joining the meeting. More...
 
virtual SDKError EnableWaitingRoomOnEntry (bool bEnable)=0
 Set to enable the attendee to enter the waiting room when joining the meeting. More...
 
virtual IList< unsigned int > * GetWaitingRoomLst ()=0
 Get the list of attendees who are in the waiting room. More...
 
virtual IUserInfoGetWaitingRoomUserInfoByID (unsigned int userid)=0
 Get the attendee information in the waiting room via user ID. More...
 
virtual SDKError AdmitToMeeting (unsigned int userid)=0
 Permit the specified user to join the meeting. More...
 
virtual SDKError PutInWaitingRoom (unsigned int userid)=0
 Enable the specified user to enter the waiting room. More...
 

Detailed Description

Meeting waiting room controller interface.

Member Function Documentation

◆ AdmitToMeeting()

virtual SDKError IMeetingWaitingRoomController::AdmitToMeeting ( unsigned int  userid)
pure virtual

Permit the specified user to join the meeting.

Parameters
useridSpecifies the user ID.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed, the return is NULL. For more details, see SDKError enum.

◆ EnableWaitingRoomOnEntry()

virtual SDKError IMeetingWaitingRoomController::EnableWaitingRoomOnEntry ( bool  bEnable)
pure virtual

Set to enable the attendee to enter the waiting room when joining the meeting.

Parameters
bEnableTrue 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, see SDKError enum.

◆ GetWaitingRoomLst()

virtual IList<unsigned int >* IMeetingWaitingRoomController::GetWaitingRoomLst ( )
pure virtual

Get the list of attendees who are in the waiting room.

Returns
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is NULL.

◆ GetWaitingRoomUserInfoByID()

virtual IUserInfo* IMeetingWaitingRoomController::GetWaitingRoomUserInfoByID ( unsigned int  userid)
pure virtual

Get the attendee information in the waiting room via user ID.

Parameters
useridSpecifies the user ID.
Returns
If the function succeeds, the return value is a pointer to IUserInfo. Otherwise failed, the return is NULL. For more details, see IUserInfo.

◆ IsSupportWaitingRoom()

virtual bool IMeetingWaitingRoomController::IsSupportWaitingRoom ( )
pure virtual

Determine whether the current meeting supports the waiting room or not.

Returns
True indicates to support.

◆ IsWaitingRoomOnEntryFlagOn()

virtual bool IMeetingWaitingRoomController::IsWaitingRoomOnEntryFlagOn ( )
pure virtual

Determine if the attendee is enabled to enter the waiting room when joining the meeting.

Returns
True indicates to enable to enter.

◆ PutInWaitingRoom()

virtual SDKError IMeetingWaitingRoomController::PutInWaitingRoom ( unsigned int  userid)
pure virtual

Enable the specified user to enter the waiting room.

Parameters
useridSpecifies the user ID.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError IMeetingWaitingRoomController::SetEvent ( IMeetingWaitingRoomEvent pEvent)
pure virtual

Set meeting waiting room callback event handler.

Parameters
pEventA pointer to the IMeetingWaitingRoomEvent that receives the waiting room event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

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