us.zoom.sdk.IBOAdmin Interface Reference

Public Member Functions
boolean	startBO ()
	Start breakout meeting. IBOAdminEvent.onStartBOResponse is the corresponding callback notification.
boolean	stopBO ()
	Stop breakout meeting. IBOAdminEvent.onStartBOResponse is the corresponding callback notification.
boolean	canStartBO ()
	Determine if the user can start breakout room.
boolean	assignNewUserToRunningBO (String strUserID, String strBOID)
	Assign user to is runing breakout meeting.
boolean	switchAssignedUserToRunningBO (String strUserID, String strBOID)
	Switch Assigned user to different Breakout meeting(BO-A to BO-B).
void	setEvent (IBOAdminEvent event)
	Set event.
boolean	joinBOByUserRequest (String strUserID)
	User request to join breakout room.
boolean	broadcastMessage (String strMsg)
	Broadcast message.
boolean	ignoreUserHelpRequest (String userId)
	Notify attendee request help result.
boolean	inviteBOUserReturnToMainSession (String userId)
	Host invite user return to main session when BO is started and user is in BO.

Detailed Description

Definition at line 3 of file IBOAdmin.java.

Member Function Documentation

assignNewUserToRunningBO()

boolean us.zoom.sdk.IBOAdmin.assignNewUserToRunningBO	(	String	strUserID,
		String	strBOID )

Assign user to is runing breakout meeting.

Parameters

strUserID	Assigned user ID.
strBOID	Breakout meeting ID.

Returns

If the function succeeds,will return true.

broadcastMessage()

boolean us.zoom.sdk.IBOAdmin.broadcastMessage

(

String

strMsg

)

Broadcast message.

Parameters

strMsg

The broadcast message.

Returns

If the function succeeds, will return true.

canStartBO()

boolean us.zoom.sdk.IBOAdmin.canStartBO

(

)

Determine if the user can start breakout room.

Returns

If return true means can start breakout room, otherwise not.

ignoreUserHelpRequest()

boolean us.zoom.sdk.IBOAdmin.ignoreUserHelpRequest

(

String

userId

)

Notify attendee request help result.

Parameters

userId

The user id of requested help.

Returns

If the function succeeds,will return true.

inviteBOUserReturnToMainSession()

boolean us.zoom.sdk.IBOAdmin.inviteBOUserReturnToMainSession

(

String

userId

)

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

Parameters

userId

invited user id

Returns

true indicates success, otherwise fail

joinBOByUserRequest()

boolean us.zoom.sdk.IBOAdmin.joinBOByUserRequest

(

String

strUserID

)

User request to join breakout room.

Parameters

strUserID

The user id.

Returns

If the function succeeds,will return true.

setEvent()

void us.zoom.sdk.IBOAdmin.setEvent

(

IBOAdminEvent

event

)

Set event.

Parameters

event

Event object.

startBO()

boolean us.zoom.sdk.IBOAdmin.startBO

(

)

Start breakout meeting. IBOAdminEvent.onStartBOResponse is the corresponding callback notification.

Returns

If the function succeeds,will return true.

stopBO()

boolean us.zoom.sdk.IBOAdmin.stopBO

(

)

Stop breakout meeting. IBOAdminEvent.onStartBOResponse is the corresponding callback notification.

Returns

If the function succeeds,will return true.

switchAssignedUserToRunningBO()

boolean us.zoom.sdk.IBOAdmin.switchAssignedUserToRunningBO	(	String	strUserID,
		String	strBOID )

Switch Assigned user to different Breakout meeting(BO-A to BO-B).

Parameters

strUserID	Assigned user ID.
strBOID	Breakout meeting ID.

Returns

If the function succeeds,will return true.