iOS SDK API Reference
Loading...
Searching...
No Matches
MobileRTCBOAdmin Class Reference

#import <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods

(BOOL) - startBO
 start bo meeting which assigned.
 
(BOOL) - stopBO
 stop bo meeting which assigned.
 
(BOOL) - assignNewUser:toRunningBO:
 assign a bo user to a started bo meeting.
 
(BOOL) - switchUser:toRunningBO:
 switch a user to a new started bo meeting.
 
(BOOL) - canStartBO
 indicate that the bo can be start or not.
 
(BOOL) - joinBOByUserRequest:
 join bo meeting for designated bo user id.
 
(BOOL) - ignoreUserHelpRequest:
 reply ignore for the help request from bo attendees
 
(BOOL) - broadcastMessage:
 broadcase message for all attendees in the meeting.
 
(BOOL) - inviteBOUserReturnToMainSession:
 Host invite user return to main session, When BO is started and user is in BO.
 

Detailed Description

Definition at line 211 of file MobileRTCBORole.h.

Method Documentation

◆ assignNewUser:toRunningBO:

- (BOOL) assignNewUser: (NSString *_Nonnull)  boUserId
toRunningBO: (NSString *_Nonnull)  boId 

assign a bo user to a started bo meeting.

Parameters
boUserIdthe BO user id.
boIdthe BO id.
Returns
the result of call the method.

◆ broadcastMessage:

- (BOOL) broadcastMessage: (NSString *_Nonnull)  strMsg

broadcase message for all attendees in the meeting.

Parameters
strMsgthe bo message.
Returns
the result of call the method.

◆ canStartBO

- (BOOL) canStartBO

indicate that the bo can be start or not.

Returns
the result of call the method.

◆ ignoreUserHelpRequest:

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

reply ignore for the help request from bo attendees

Parameters
boUserIdthe BO user id.
Returns
the result of call the method.

◆ inviteBOUserReturnToMainSession:

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

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

Parameters
boUserIdthe bo user id.
Returns
true indicates success, otherwise fail.

◆ joinBOByUserRequest:

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

join bo meeting for designated bo user id.

Parameters
boUserIdthe BO user id.
Returns
the result of call the method.

◆ startBO

- (BOOL) startBO

start bo meeting which assigned.

Returns
start success or not

◆ stopBO

- (BOOL) stopBO

stop bo meeting which assigned.

Returns
stop success or not

◆ switchUser:toRunningBO:

- (BOOL) switchUser: (NSString *_Nonnull)  boUserId
toRunningBO: (NSString *_Nonnull)  boId 

switch a user to a new started bo meeting.

Parameters
boUserIdthe BO user id.
boIdthe BO id.
Returns
the result of call the method.