ZoomSDKBOMeetingAdmin Class Reference

A controller for managing breakout room operations as the admin. More...

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- startBO
	Starts breakout meeting. '-onStartBOResponse:' is the corresponding callback notification.
(ZoomSDKError)	- stopBO
	Stops breakout meeting. '-onStopBOResponse:' is the corresponding callback notification.
(ZoomSDKError)	- assignNewUserToRunningBO:BOID:
	Assign user to is runing breakout meeting.
(ZoomSDKError)	- switchAssignedUserToRunningBO:BOID:
	Switch Assigned user to differnt Breakout meeting(BO-A to BO-B).
(BOOL)	- canStartBO
	Determines if the user can start breakout room.
(ZoomSDKError)	- joinBOByUserRequest:
	User request to join breakout room.
(ZoomSDKError)	- ignoreUserHelpRequest:
	Notify attendee request help result.
(ZoomSDKError)	- broadcastMessage:
	Broadcast message.
(ZoomSDKError)	- inviteBOUserReturnToMainSession:
	Host invite user return to main session, When BO is started and user is in BO.
(BOOL)	- isBroadcastVoiceToBOSupport
	Query if the current meeting supports broadcasting host's voice to BO.
(BOOL)	- canBroadcastVoiceToBO
	Query if the host now has the ability to broadcast voice to BO.
(ZoomSDKError)	- broadcastVoiceToBO:
	Starts or stop broadcasting voice to BO.

Properties
id< ZoomSDKBOMeetingAdminDelegate >	delegate
	Sets or get the delegate to receive breakout room admin callbacks.

Detailed Description

A controller for managing breakout room operations as the admin.

Definition at line 310 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

assignNewUserToRunningBO:BOID:

- (ZoomSDKError) assignNewUserToRunningBO:		(NSString *)	userID
BOID:		(NSString *)	ID

Assign user to is runing breakout meeting.

Parameters

userID	Assigned user ID.
ID	Breakout meeting ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

broadcastMessage:

- (ZoomSDKError) broadcastMessage:

(NSString *)

message

Broadcast message.

Parameters

message

The broadcast context.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

broadcastVoiceToBO:

- (ZoomSDKError) broadcastVoiceToBO:

(BOOL)

start

Starts or stop broadcasting voice to BO.

Parameters

start

YES for start and NO for stop.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

canBroadcastVoiceToBO

- (BOOL) canBroadcastVoiceToBO

Query if the host now has the ability to broadcast voice to BO.

Returns

YES if the host now has the ability. Otherwise, NO.

canStartBO

- (BOOL) canStartBO

Determines if the user can start breakout room.

Returns

If returns YES, can start breakout room. Otherwise, NO.

ignoreUserHelpRequest:

- (ZoomSDKError) ignoreUserHelpRequest:

(NSString *)

userID

Notify attendee request help result.

Parameters

userID

The user ID of requested help.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

inviteBOUserReturnToMainSession:

- (ZoomSDKError) inviteBOUserReturnToMainSession:

(NSString *)

userID

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

Parameters

userID

The user ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

isBroadcastVoiceToBOSupport

- (BOOL) isBroadcastVoiceToBOSupport

Query if the current meeting supports broadcasting host's voice to BO.

Returns

YES if the meeting supports this. Otherwise, NO.

joinBOByUserRequest:

- (ZoomSDKError) joinBOByUserRequest:

(NSString *)

requestUserID

User request to join breakout room.

Parameters

requestUserID

The user ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

startBO

- (ZoomSDKError) startBO

Starts breakout meeting. '-onStartBOResponse:' is the corresponding callback notification.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

stopBO

- (ZoomSDKError) stopBO

Stops breakout meeting. '-onStopBOResponse:' is the corresponding callback notification.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

switchAssignedUserToRunningBO:BOID:

- (ZoomSDKError) switchAssignedUserToRunningBO:		(NSString *)	userID
BOID:		(NSString *)	ID

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

Parameters

userID	Assigned user ID.
ID	Breakout meeting ID.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Property Documentation

delegate

- (id<ZoomSDKBOMeetingAdminDelegate>) delegate

readwritenonatomicassign

Sets or get the delegate to receive breakout room admin callbacks.

Definition at line 314 of file ZoomSDKNewBreakoutRoomController.h.