Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKBOMeetingDataHelp Class Reference

Provides data helper functions for breakout meetings. More...

#include <ZoomSDKNewBreakoutRoomController.h>

Inherits NSObject.

Instance Methods

(NSArray *_Nullable) - getUnassignedUserList
 Get unassigned user list.
 
(NSArray *_Nullable) - getBOMeetingIDList
 Get breakout meeting ID list.
 
(NSString *_Nullable) - getBOUserNameWithUserID:
 Get breakout meeting user name.
 
(ZoomSDKBOMeetingInfo *_Nullable) - getBOMeetingInfoWithBOID:
 Get breakout meeting info.
 
(BOOL) - isMyselfInBo:
 Determine if it is yourself by userID.
 
(NSString *_Nullable) - getCurrentBoName
 Get breakout meeting name.
 

Properties

id< ZoomSDKBOMeetingDataHelpDelegatedelegate
 Set or get the delegate to receive breakout room data helper callbacks.
 

Detailed Description

Provides data helper functions for breakout meetings.

Definition at line 511 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

◆ getBOMeetingIDList

- (NSArray *_Nullable) getBOMeetingIDList

Get breakout meeting ID list.

Returns
If the function succeeds, will return breakout meeting ID array.

◆ getBOMeetingInfoWithBOID:

- (ZoomSDKBOMeetingInfo *_Nullable) getBOMeetingInfoWithBOID: (NSString *) BOID

Get breakout meeting info.

Parameters
BOIDBreakout meeting ID.
Returns
If the function succeeds, will return ZoomSDKBOMeetingInfo object.

◆ getBOUserNameWithUserID:

- (NSString *_Nullable) getBOUserNameWithUserID: (NSString *) userID

Get breakout meeting user name.

Parameters
userIDThe user's user ID.
Returns
If the function succeeds, will return user name.

◆ getCurrentBoName

- (NSString *_Nullable) getCurrentBoName

Get breakout meeting name.

Returns
The name of current breakout meeting.

◆ getUnassignedUserList

- (NSArray *_Nullable) getUnassignedUserList

Get unassigned user list.

Returns
If the function succeeds, will return unassigned user array.

◆ isMyselfInBo:

- (BOOL) isMyselfInBo: (NSString *) userid

Determine if it is yourself by userID.

Parameters
useridThe user's user ID.
Returns
YES means yourself is in the breakout meeting ,otherwise not.

Property Documentation

◆ delegate

- (id<ZoomSDKBOMeetingDataHelpDelegate>) delegate
readwritenonatomicassign

Set or get the delegate to receive breakout room data helper callbacks.

Definition at line 516 of file ZoomSDKNewBreakoutRoomController.h.