macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKBOMeetingCreator Class Reference

#import <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods

(NSString *) - createBOWithBOName:
 Creator breakout meeting.
 
(ZoomSDKError- createBOWithBONameList:
 Creator breakout meeting in batch.
 
(ZoomSDKError- updateBOName:BOID:
 Update breakout meeting information.
 
(ZoomSDKError- removeBO:
 Remove breakout meeting by ID.
 
(ZoomSDKError- assignUserToBO:BOID:
 Assign user to Breakout meeting.
 
(ZoomSDKError- removeUserFromBO:BOID:
 Removed user from Breakout meeting.
 
(ZoomSDKError- setBOOption:
 Set BO option.
 
(ZoomSDKBOOption *) - getBOOption
 Get BO option.
 

Properties

id< ZoomSDKBOMeetingCreatorDelegatedelegate
 

Detailed Description

Definition at line 63 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

◆ assignUserToBO:BOID:

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

Assign user to Breakout meeting.

Parameters
userIDAssigned user ID.
IDBreakout meeting ID.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ createBOWithBOName:

- (NSString *) createBOWithBOName: (NSString *)  name

Creator breakout meeting.

Parameters
nameBreakout meeting name,should less than 50 characters.
Returns
If the function succeeds,will return breakout meeting id, otherwise return nil,

◆ createBOWithBONameList:

- (ZoomSDKError) createBOWithBONameList: (NSArray< NSString * > *)  nameList

Creator breakout meeting in batch.

Parameters
nameListBreakout meeting name list,the element of nameList should less than 50 characters.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ getBOOption

- (ZoomSDKBOOption *) getBOOption

Get BO option.

Returns
The value is bo option object.

◆ removeBO:

- (ZoomSDKError) removeBO: (NSString *)  BOID

Remove breakout meeting by ID.

Parameters
BOIDNeed remove breakout meeting ID.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ removeUserFromBO:BOID:

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

Removed user from Breakout meeting.

Parameters
userIDRemoved user ID.
IDBreakout meeting ID.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ setBOOption:

- (ZoomSDKError) setBOOption: (ZoomSDKBOOption *)  boOption

Set BO option.

Parameters
boOptionThe option that you want to set.
Returns
If the function succeeds,will return ZoomSDKError_Success.

◆ updateBOName:BOID:

- (ZoomSDKError) updateBOName: (NSString *)  newName
BOID: (NSString *)  ID 

Update breakout meeting information.

Parameters
newNameBreakout meeting new name.
IDBreakout meeting ID.
Returns
If the function succeeds,will return ZoomSDKError_Success.

Property Documentation

◆ delegate

- (id<ZoomSDKBOMeetingCreatorDelegate>) delegate
readwritenonatomicassign

Definition at line 65 of file ZoomSDKNewBreakoutRoomController.h.