MobileRTCBORole.h

Go to the documentation of this file.

//
//  MobileRTCBORole.h
//  MobileRTC
//
//  Created by Zoom Communications on 2020/2/11.
//  Copyright © Zoom Communications, Inc. All rights reserved.
//
 
#import <Foundation/Foundation.h>
 
typedef enum : NSUInteger {
    BOUserStatusUnknown      = 0,
    BOUserStatusUnassigned  = 1,
    BOUserStatusNotJoin     = 2,
    BOUserStatusInBO        = 3,
} MobileRTCBOUserStatus;
 
@interface MobileRTCBOUser : NSObject
- (NSString * _Nullable)getUserId;
 
- (NSString * _Nullable)getUserName;
 
@end
 
@interface MobileRTCBOMeeting : NSObject
- (NSString * _Nullable)getBOMeetingId;
 
- (NSString * _Nullable)getBOMeetingName;
 
- (NSArray <NSString *>* _Nullable)getBOMeetingUserList;
 
-(MobileRTCBOUserStatus)getBOUserStatusWithUserID:(NSString *_Nonnull)userID;
@end
 
typedef NS_ENUM(NSUInteger, MobileRTCBOStopCountDown) {
    MobileRTCBOStopCountDown_Not_CountDown  = 0,
    MobileRTCBOStopCountDown_Seconds_10,
    MobileRTCBOStopCountDown_Seconds_15,
    MobileRTCBOStopCountDown_Seconds_30,
    MobileRTCBOStopCountDown_Seconds_60,
    MobileRTCBOStopCountDown_Seconds_120,
};
 
@interface MobileRTCBOOption : NSObject
@property (nonatomic, assign) MobileRTCBOStopCountDown countdownSeconds;
@property (nonatomic, assign) BOOL isParticipantCanChooseBO;
@property (nonatomic, assign) BOOL isParticipantCanReturnToMainSessionAtAnyTime;
@property (nonatomic, assign) BOOL isAutoMoveAllAssignedParticipantsEnabled;
@property (nonatomic, assign) BOOL isBOTimerEnabled;
@property (nonatomic, assign) BOOL isTimerAutoStopBOEnabled;
@property (nonatomic, assign) NSInteger timerDuration;
 
//  WebinarBo
@property(nonatomic,assign) BOOL isAttendeeContained;
 
@property(nonatomic,assign) BOOL isPanelistCanChooseBO;
 
@property(nonatomic,assign) BOOL isAttendeeCanChooseBO;
 
@property(nonatomic,assign) BOOL isUserConfigMaxRoomUserLimitsEnabled;
 
@property(nonatomic,assign)unsigned int nUserConfigMaxRoomUserLimits;
 
@end
 
@interface MobileRTCBOCreator : NSObject
- (NSString * _Nullable)createBO:(NSString * _Nonnull)boName DEPRECATED_MSG_ATTRIBUTE("Use createBreakoutRoom: instead");
 
- (BOOL)createBreakoutRoom:(NSString * _Nonnull)boName;
 
- (BOOL)createGroupBO:(NSArray<NSString*> * _Nonnull)boNameList;
 
- (BOOL)createWebinarBO:(NSArray<NSString*> * _Nonnull)boNameList;
 
- (BOOL)updateBO:(NSString * _Nonnull)boId name:(NSString * _Nonnull)boName;
 
- (BOOL)removeBO:(NSString * _Nonnull)boId;
 
- (BOOL)assignUser:(NSString * _Nonnull)boUserId toBO:(NSString * _Nonnull)boId;
 
- (BOOL)removeUser:(NSString * _Nonnull)boUserId fromBO:(NSString * _Nonnull)boId;
 
- (BOOL)setBOOption:(MobileRTCBOOption *_Nonnull)option;
 
- (MobileRTCBOOption * _Nullable)getBOOption;
 
- (BOOL)isWebPreAssignBOEnabled;
 
- (MobileRTCSDKError)requestAndUseWebPreAssignBOList;
 
- (MobileRTCBOPreAssignBODataStatus)getWebPreAssignBODataStatus;
 
@end
 
@interface MobileRTCBOAdmin : NSObject
- (BOOL)startBO;
 
- (BOOL)stopBO;
 
- (BOOL)assignNewUser:(NSString * _Nonnull)boUserId toRunningBO:(NSString * _Nonnull)boId;
 
- (BOOL)switchUser:(NSString * _Nonnull)boUserId toRunningBO:(NSString * _Nonnull)boId;
 
- (BOOL)canStartBO;
 
- (BOOL)joinBOByUserRequest:(NSString * _Nonnull)boUserId;
 
- (BOOL)ignoreUserHelpRequest:(NSString * _Nonnull)boUserId;
 
- (BOOL)broadcastMessage:(NSString * _Nonnull)strMsg;
 
- (BOOL)inviteBOUserReturnToMainSession:(NSString * _Nonnull)boUserId;
- (BOOL)isBroadcastVoiceToBOSupport;
 
- (BOOL)canBroadcastVoiceToBO;
- (BOOL)broadcastVoiceToBO:(BOOL)bStart;
@end
 
@interface MobileRTCBOAssistant : NSObject
 
- (BOOL)joinBO:(NSString * _Nonnull)boId;
 
- (BOOL)leaveBO;
 
@end
 
@interface MobileRTCBOAttendee : NSObject
 
- (BOOL)joinBO;
 
- (BOOL)leaveBO;
 
- (NSString * _Nullable)getBOName;
 
- (BOOL)requestForHelp;
 
- (BOOL)isHostInThisBO;
 
- (BOOL)isCanReturnMainSession;
 
@end
 
@interface MobileRTCBOData : NSObject
 
- (NSArray * _Nullable)getUnassignedUserList;
 
- (NSArray * _Nullable)getBOMeetingIDList;
 
- (MobileRTCBOUser * _Nullable)getBOUserByUserID:(NSString * _Nonnull)userId;
 
- (MobileRTCBOMeeting * _Nullable)getBOMeetingByID:(NSString * _Nonnull)boId;
 
- (NSString  * _Nullable)getCurrentBOName;
 
- (BOOL)isBOUserMyself:(NSString *_Nonnull)boUserId;
 
@end