IBOAdmin Class Reference

BO admin interface. More...

#include <meeting_breakout_rooms_interface_v2.h>

Public Member Functions
virtual bool	StartBO ()=0
	start BO. More...
virtual bool	StopBO ()=0
	stop BO. More...
virtual bool	AssignNewUserToRunningBO (const wchar_t *strUserID, const wchar_t *strBOID)=0
	To set a unassigned user to a BO, when BO is started. More...
virtual bool	SwitchAssignedUserToRunningBO (const wchar_t *strUserID, const wchar_t *strBOID)=0
	To Switch user to other BO, when BO is started. More...
virtual bool	CanStartBO ()=0
	Determine if can start BO. More...
virtual void	SetEvent (IBOAdminEvent *pEvent)=0
	Set admin callback handler. More...
virtual bool	JoinBOByUserRequest (const wchar_t *strUserID)=0
	To join the BO which request help is from. More...
virtual bool	IgnoreUserHelpRequest (const wchar_t *strUserID)=0
	To ignore the request help. More...
virtual bool	BroadcastMessage (const wchar_t *strMsg)=0
	To send the broadcast message. More...
virtual bool	InviteBOUserReturnToMainSession (const wchar_t *strUserID)=0
	Host invite user return to main session, When BO is started and user is in BO. More...

Detailed Description

BO admin interface.

Definition at line 255 of file meeting_breakout_rooms_interface_v2.h.

Member Function Documentation

AssignNewUserToRunningBO()

virtual bool IBOAdmin::AssignNewUserToRunningBO ( const wchar_t *  strUserID, const wchar_t *  strBOID  )

pure virtual

To set a unassigned user to a BO, when BO is started.

Returns

true indicates success, otherwise fail.

BroadcastMessage()

virtual bool IBOAdmin::BroadcastMessage ( const wchar_t *  strMsg )

pure virtual

To send the broadcast message.

Returns

true indicates success, otherwise fail.

CanStartBO()

virtual bool IBOAdmin::CanStartBO ( )

pure virtual

Determine if can start BO.

Returns

true indicates can, otherwise can not.

IgnoreUserHelpRequest()

virtual bool IBOAdmin::IgnoreUserHelpRequest ( const wchar_t *  strUserID )

pure virtual

To ignore the request help.

Returns

true indicates success, otherwise fail.

InviteBOUserReturnToMainSession()

virtual bool IBOAdmin::InviteBOUserReturnToMainSession ( const wchar_t *  strUserID )

pure virtual

Host invite user return to main session, When BO is started and user is in BO.

Returns

true indicates success, otherwise fail.

JoinBOByUserRequest()

virtual bool IBOAdmin::JoinBOByUserRequest ( const wchar_t *  strUserID )

pure virtual

To join the BO which request help is from.

Returns

true indicates success, otherwise fail.

SetEvent()

virtual void IBOAdmin::SetEvent ( IBOAdminEvent *  pEvent )

pure virtual

Set admin callback handler.

Parameters

pEvent,A

pointer to the IBOAdminEvent. For more details, see IBOAdminEvent.

StartBO()

virtual bool IBOAdmin::StartBO ( )

pure virtual

start BO.

Returns

true indicates success, otherwise fail.

StopBO()

virtual bool IBOAdmin::StopBO ( )

pure virtual

stop BO.

Returns

true indicates success, otherwise fail.

SwitchAssignedUserToRunningBO()

virtual bool IBOAdmin::SwitchAssignedUserToRunningBO ( const wchar_t *  strUserID, const wchar_t *  strBOID  )

pure virtual

To Switch user to other BO, when BO is started.

Returns

true indicates success, otherwise fail.