Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCBOData Class Reference

A class that provides data helper functions for breakout meetings. More...

#include <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods

(NSArray *_Nullable) - getUnassignedUserList
 Gets the unassigned user list.
 
(NSArray *_Nullable) - getBOMeetingIDList
 Gets all breakout meeting ID list.
 
(MobileRTCBOUser *_Nullable) - getBOUserByUserID:
 Gets the breakout room user object by breakout room user ID.
 
(MobileRTCBOMeeting *_Nullable) - getBOMeetingByID:
 Gets the breakout meeting object by breakout meeting ID.
 
(NSString *_Nullable) - getCurrentBOName
 Gets the breakout meeting name of the current breakout room.
 
(BOOL) - isBOUserMyself:
 Determines whether the breakout room user ID is the current user.
 

Detailed Description

A class that provides data helper functions for breakout meetings.

Definition at line 473 of file MobileRTCBORole.h.

Method Documentation

◆ getBOMeetingByID:

- (MobileRTCBOMeeting *_Nullable) getBOMeetingByID: (NSString *_Nonnull) boId

Gets the breakout meeting object by breakout meeting ID.

Parameters
boIdThe breakout room ID.
Returns
If the function succeeds, it returns a MobileRTCBOMeeting object. Otherwise, this function fails and returns nil.

◆ getBOMeetingIDList

- (NSArray *_Nullable) getBOMeetingIDList

Gets all breakout meeting ID list.

Returns
The breakout meeting ID list.

◆ getBOUserByUserID:

- (MobileRTCBOUser *_Nullable) getBOUserByUserID: (NSString *_Nonnull) userId

Gets the breakout room user object by breakout room user ID.

Parameters
userIdThe user ID.
Returns
If the function succeeds, it returns a MobileRTCBOUser object. Otherwise, this function fails and returns nil.

◆ getCurrentBOName

- (NSString *_Nullable) getCurrentBOName

Gets the breakout meeting name of the current breakout room.

Returns
The current breakout room name.

◆ getUnassignedUserList

- (NSArray *_Nullable) getUnassignedUserList

Gets the unassigned user list.

Returns
The unassigned user list.

◆ isBOUserMyself:

- (BOOL) isBOUserMyself: (NSString *_Nonnull) boUserId

Determines whether the breakout room user ID is the current user.

Parameters
boUserIdThe breakout room user ID.
Returns
YES if the breakout room user ID is the current user. Otherwise, NO.