MobileRTCBOCreator Class Reference

#import <MobileRTCBORole.h>

Inherits NSObject.

Instance Methods
(NSString *_Nullable)	- createBO:
	create a bo meeting.
(BOOL)	- createGroupBO:
	create bo meetings in batches.
(BOOL)	- updateBO:name:
	update bo meeting name with bo id.
(BOOL)	- removeBO:
	remove a bo meeting.
(BOOL)	- assignUser:toBO:
	assign a user to a bo meeting.
(BOOL)	- removeUser:fromBO:
	remove a user from a bo meeting.
(BOOL)	- setBOOption:
	Set BO option.
(MobileRTCBOOption *_Nullable)	- getBOOption
	Get BO option.

Detailed Description

//////////////////////////// Creator ////////////////////////////

1. Main Functions: 1) create|delete|rename BO 2) assign|remove user to BO 3) set BO option
2. Remarks: 1) These editing can only be done before BO is started

//////////////////////////// Admin ////////////////////////////

1. Main Functions: 1) after BO is started, assign new user to BO, 2) after BO is started, switch user from BO-A to BO-B 3) stop BO 4) start BO

   //////////////////////////// Assistant ////////////////////////////

   1. Main Functions: 1) join BO with BO id 2) leave BO

//////////////////////////// Attendee ////////////////////////////

1. Main Functions: 1) join BO 2) leave BO 3) request help

   //////////////////////////// DataHelper ////////////////////////////

   1. Main Functions: 1) get unassigned user list 2) get BO list 3) get BO object

   host in master conference : creator + admin + assistant + dataHelper host in BO conference : admin + assistant + dataHelper CoHost in master conference : [attendee] or [creator + admin + assistant + dataHelper] CoHost in BO conference : [attendee] or [admin + assistant + dataHelper] attendee in master conference : attendee + [assistant + dataHelper] attendee in BO conference : attendee + [assistant + dataHelper]

Import Remarks:

1. attendee in master conference/attendee in BO conference 1) if BOOption.IsParticipantCanChooseBO is true, attendee has objects: [attendee + assistant + dataHelper] 2) if BOOption.IsParticipantCanChooseBO is false, attendee has object: [attendee]
2. CoHost in master conference 1) if CoHost is desktop client, and host is desktop client, the CoHost has objects: [creator + admin + assistant + dataHelper] 2) if CoHost is desktop client, and host is mobile client, the CoHost has object: [attendee] 3) if CoHost is mobile client, the CoHost has object: [attendee]

Definition at line 152 of file MobileRTCBORole.h.

Method Documentation

assignUser:toBO:

- (BOOL) assignUser:		(NSString *_Nonnull)	boUserId
toBO:		(NSString *_Nonnull)	boId

assign a user to a bo meeting.

Parameters

boUserId	the BO user id.
boId	the BO id.

Returns

assign success or not.

createBO:

- (NSString *_Nullable) createBO:

(NSString *_Nonnull)

boName

create a bo meeting.

Parameters

boName

the BO name.

Returns

bo meeting id.

createGroupBO:

- (BOOL) createGroupBO:

(NSArray< NSString * > *_Nonnull)

boNameList

create bo meetings in batches.

Parameters

boNameList

the BO name list.

Returns

batch bo create success or not

getBOOption

- (MobileRTCBOOption *_Nullable) getBOOption

Get BO option.

Returns

the BOOption value.

removeBO:

- (BOOL) removeBO:

(NSString *_Nonnull)

boId

remove a bo meeting.

Parameters

boId	the BO id.

Returns

remove bo meting success or not.

removeUser:fromBO:

- (BOOL) removeUser:		(NSString *_Nonnull)	boUserId
fromBO:		(NSString *_Nonnull)	boId

remove a user from a bo meeting.

Returns

remove success or not.

setBOOption:

- (BOOL) setBOOption:

(MobileRTCBOOption *_Nonnull)

option

Set BO option.

Parameters

option,the

option that you want to set.

Returns

if success the return value is true, otherwise false.

updateBO:name:

- (BOOL) updateBO:		(NSString *_Nonnull)	boId
name:		(NSString *_Nonnull)	boName

update bo meeting name with bo id.

Parameters

boId	the BO id.
boName	the BO name.

Returns

update success or not.