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
 Gets unassigned user list.
 
(NSArray *_Nullable) - getBOMeetingIDList
 Gets breakout meeting ID list.
 
(NSString *_Nullable) - getBOUserNameWithUserID:
 Gets breakout meeting user name.
 
(ZoomSDKBOMeetingInfo *_Nullable) - getBOMeetingInfoWithBOID:
 Gets breakout meeting info.
 
(BOOL) - isMyselfInBo:
 Determines if it is yourself by userID.
 
(NSString *_Nullable) - getCurrentBoName
 Gets breakout meeting name.
 

Properties

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

Detailed Description

Provides data helper functions for breakout meetings.

Definition at line 520 of file ZoomSDKNewBreakoutRoomController.h.

Method Documentation

◆ getBOMeetingIDList

- (NSArray *_Nullable) getBOMeetingIDList

Gets breakout meeting ID list.

Returns
If the function succeeds, it returns breakout meeting ID array. Otherwise, this function fails and returns nil.

◆ getBOMeetingInfoWithBOID:

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

Gets breakout meeting info.

Parameters
BOIDBreakout meeting ID.
Returns
If the function succeeds, it returns ZoomSDKBOMeetingInfo object. Otherwise, this function fails and returns nil.

◆ getBOUserNameWithUserID:

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

Gets breakout meeting user name.

Parameters
userIDThe user ID.
Returns
If the function succeeds, it returns user name. Otherwise, this function fails and returns nil.

◆ getCurrentBoName

- (NSString *_Nullable) getCurrentBoName

Gets breakout meeting name.

Returns
The current breakout meeting's name. Otherwise, this function fails and returns nil.

◆ getUnassignedUserList

- (NSArray *_Nullable) getUnassignedUserList

Gets unassigned user list.

Returns
If the function succeeds, it returns unassigned user array. Otherwise, this function fails and returns nil.

◆ isMyselfInBo:

- (BOOL) isMyselfInBo: (NSString *) userid

Determines if it is yourself by userID.

Parameters
useridThe user ID.
Returns
YES if yourself is in the breakout meeting. Otherwise, NO.

Property Documentation

◆ delegate

- (id<ZoomSDKBOMeetingDataHelpDelegate>) delegate
readwritenonatomicassign

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

Definition at line 525 of file ZoomSDKNewBreakoutRoomController.h.