Zoom Rooms Controller SDK Reference 7.2.0
Loading...
Searching...
No Matches
IBOAdminHelperSink Class Referenceabstract

BO admin callback handler. More...

#include <IBreakoutRoomHelper.h>

Public Member Functions

virtual ~IBOAdminHelperSink ()
 
virtual void OnBOHelpRequestReceived (const std::string &userGUID, const BreakoutRoomInfo &boRoomInfo)=0
 Receive help request from user in bo.
 
virtual void OnBOEndTimerUpdate (uint64_t remainingSecond)=0
 BO end timer update notification, if BO enable timer, you will receive this notification when bo starts.
 
virtual void OnBOTimeIsUpNotification ()=0
 BO time is up notification, you can decide to stop BO immediately or later.
 
virtual void OnBOReachCapacity (bool reached)=0
 BO reach capacity notification.
 

Detailed Description

BO admin callback handler.

Definition at line 214 of file IBreakoutRoomHelper.h.

Constructor & Destructor Documentation

◆ ~IBOAdminHelperSink()

virtual IBOAdminHelperSink::~IBOAdminHelperSink ( )
inlinevirtual

Definition at line 217 of file IBreakoutRoomHelper.h.

217{}

Member Function Documentation

◆ OnBOEndTimerUpdate()

virtual void IBOAdminHelperSink::OnBOEndTimerUpdate ( uint64_t  remainingSecond)
pure virtual

BO end timer update notification, if BO enable timer, you will receive this notification when bo starts.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
remainingSecondThe bo remaining time in seconds.

◆ OnBOHelpRequestReceived()

virtual void IBOAdminHelperSink::OnBOHelpRequestReceived ( const std::string &  userGUID,
const BreakoutRoomInfo &  boRoomInfo 
)
pure virtual

Receive help request from user in bo.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
userGUIDThe user guid.
boRoomInfoThe bo room info.

◆ OnBOReachCapacity()

virtual void IBOAdminHelperSink::OnBOReachCapacity ( bool  reached)
pure virtual

BO reach capacity notification.

Since
7.2.0
Zoom Rooms minimum version
7.2.0
Parameters
reachedTrue indicates BO has reached the max room capacity, false indicates it's no longer at capacity.

◆ OnBOTimeIsUpNotification()

virtual void IBOAdminHelperSink::OnBOTimeIsUpNotification ( )
pure virtual

BO time is up notification, you can decide to stop BO immediately or later.

Since
6.0.0
Zoom Rooms minimum version
6.0.0