macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKNewBreakoutRoomController.h
Go to the documentation of this file.
1
2#import <Foundation/Foundation.h>
3#import "ZoomSDKErrors.h"
4
5NS_ASSUME_NONNULL_BEGIN
6@interface ZoomSDKBOMeetingInfo : NSObject
7
12-(NSString *)getBOID;
13
18-(NSString *)getBOName;
19
24-(NSArray *)getBOUserlist;
25@end
26
27@interface ZoomSDKBOOption : NSObject
28
30@property(nonatomic,assign)ZoomSDKBOStopCountDown countDown;
31
33@property(nonatomic,assign)BOOL isParticipantCanChooseBO;
34
36@property(nonatomic,assign)BOOL isParticipantCanReturnToMainSessionAtAnyTime;
37
39@property(nonatomic,assign)BOOL isAutoMoveAllAssignedParticipantsEnabled;
40
42@property(nonatomic,assign)BOOL isBOTimerEnabled;
43
45@property(nonatomic,assign)BOOL isTimerAutoStopBOEnabled;
46
48@property(nonatomic,assign)unsigned int nTimerDuration;
49
50@end
51
52@protocol ZoomSDKBOMeetingCreatorDelegate <NSObject>
53@optional
54
59-(void)onBOCreateSuccess:(NSString *)boID;
60
61@end
62
63@interface ZoomSDKBOMeetingCreator : NSObject
64
65@property(nonatomic,assign)id<ZoomSDKBOMeetingCreatorDelegate> delegate;
66
72-(NSString *)createBOWithBOName:(NSString*)name;
73
79-(ZoomSDKError)createBOWithBONameList:(NSArray<NSString *>*)nameList;
80
87-(ZoomSDKError)updateBOName:(NSString*)newName BOID:(NSString *)ID;
88
94-(ZoomSDKError)removeBO:(NSString*)BOID;
95
102-(ZoomSDKError)assignUserToBO:(NSString *)userID BOID:(NSString *)ID;
103
110-(ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
111
117-(ZoomSDKError)setBOOption:(ZoomSDKBOOption *)boOption;
118
123-(ZoomSDKBOOption *)getBOOption;
124
125@end
126
127@protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
128@optional
133-(void)onHelpRequestReceived:(NSString *)userID;
134
139-(void)onStartBOError:(ZoomSDKBOControllerError)errCode;
140
146-(void)onBOEndTimerUpdated:(unsigned int)remaining isTimesUpNotice:(BOOL)isTimesUpNotice;
147
148@end
149
150@interface ZoomSDKBOMeetingAdmin : NSObject
151
152@property(nonatomic,assign)id<ZoomSDKBOMeetingAdminDelegate> delegate;
157-(ZoomSDKError)startBO;
158
163-(ZoomSDKError)stopBO;
164
171-(ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
172
179-(ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
180
185-(BOOL)canStartBO;
186
192-(ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;
193
199-(ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;
200
206-(ZoomSDKError)broadcastMessage:(NSString *)message;
207
213-(ZoomSDKError)inviteBOUserReturnToMainSession:(NSString *)userID;
214
215@end
216
217@interface ZoomSDKBOMeetingAssistant : NSObject
218
224-(ZoomSDKError)joinBO:(NSString*)ID;
225
230-(ZoomSDKError)leaveBO;
231@end
232
233@protocol ZoomSDKBOMeetingAttendeeDelegate <NSObject>
234@optional
239-(void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;
240
244-(void)onHostJoinedThisBOMeeting;
245
249-(void)onHostLeaveThisBOMeeting;
250
251@end
252
253@interface ZoomSDKBOMeetingAttendee : NSObject
254
255@property(nonatomic,assign)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
260-(ZoomSDKError)joinBO;
261
266-(ZoomSDKError)leaveBO;
267
272-(NSString*)getBOName;
273
278-(ZoomSDKError)requestForHelp;
279
284-(BOOL)isHostInThisBO;
285
290-(BOOL)isCanReturnMainSession;
291
292@end
293
294@protocol ZoomSDKBOMeetingDataHelpDelegate <NSObject>
295@optional
296
301-(void)onBOMeetingInfoUpdata:(NSString *)boID DEPRECATED_MSG_ATTRIBUTE("Use -onBOMeetingInfoUpdated: instead");
302
307-(void)onBOMeetingInfoUpdated:(NSString *)boID;
308
312-(void)onUnAssignedUserUpdated;
313
317-(void)onBOListInfoUpdated;
318@end
319
320@interface ZoomSDKBOMeetingDataHelp : NSObject
321
325@property(nonatomic,assign)id<ZoomSDKBOMeetingDataHelpDelegate> delegate;
326
331-(NSArray *)getUnassignedUserList;
332
337-(NSArray *)getBOMeetingIDList;
338
344-(NSString *)getBOUserNameWithUserID:(NSString *)userID;
345
351-(ZoomSDKBOUserStatus)getBOUserStatusWithUserID:(NSString *)userID;
352
358-(ZoomSDKBOMeetingInfo *)getBOMeetingInfoWithBOID:(NSString *)BOID;
359
365-(BOOL)isMyselfInBo:(NSString *)userid;
366
371-(NSString*)getCurrentBoName;
372@end
373
375
380-(ZoomSDKError)returnToMainSession;
381
385-(void)ignore;
386
387@end
388
389@protocol ZoomSDKNewBreakoutRoomControllerDelegate <NSObject>
390@optional
391
396-(void)onHasCreatorPermission:(ZoomSDKBOMeetingCreator *)creatorObject;
397
402-(void)onHasAdminPermission:(ZoomSDKBOMeetingAdmin *)adminObject;
403
408-(void)onHasAssistantPermission:(ZoomSDKBOMeetingAssistant *)assistantObject;
409
414-(void)onHasAttendeePermission:(ZoomSDKBOMeetingAttendee *)attendeeObject;
415
420-(void)onHasDataHelperPermission:(ZoomSDKBOMeetingDataHelp *)dataHelpObject;
421
425-(void)onLostCreatorPermission;
426
430-(void)onLostAdminPermission;
431
435-(void)onLostAssistantPermission;
436
440-(void)onLostAttendeePermission;
441
445-(void)onLostDataHelperPermission;
446
452-(void)onNewBroadcastMessageReceived:(NSString *)message senderUserId:(unsigned int)userid;
453
458-(void)onBOStopCountDown:(ZoomSDKBOStopCountDown)countDown;
459
465-(void)onHostInviteReturnToMainSession:(NSString*)userName handler:(ZoomSDKBOMeetingReturnToMainSessionHandler*)handler;
466
471-(void)onBOControlStatusChanged:(ZoomSDKBOStatus)status;
472
478-(void)onBOSwitchRequestReceived:(NSString*)newBOName newBOID:(NSString*)newBOID;
479@end
480
482
483@property(nonatomic,assign)id<ZoomSDKNewBreakoutRoomControllerDelegate> delegate;
484
490-(ZoomSDKBOMeetingCreator *)getBOMeetingCreator;
491
497-(ZoomSDKBOMeetingAdmin *)getBOMeetingAdmin;
498
504-(ZoomSDKBOMeetingAssistant *)getBOMeetingAssistant;
505
511-(ZoomSDKBOMeetingAttendee *)getBOMeetingAttendee;
512
518-(ZoomSDKBOMeetingDataHelp *)getBOMeetingDataHelp;
519
524-(BOOL)isBOStart;
525
530-(BOOL)isBOEnable;
531
536-(BOOL)isInBOMeeting;
537
542-(ZoomSDKBOStatus)getBOStatus;
543@end
544
545NS_ASSUME_NONNULL_END
ZoomSDKBOUserStatus
Enumerations of breakout meeting status.
ZoomSDKBOStatus
Enum for BO status.
ZoomSDKBOControllerError
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKRequest4HelpResult
Enumerations of attendee request for help result.
ZoomSDKBOStopCountDown
Enum for BO stop countdown.
NSString * getBOID()
Get breakout meeting id.
NSArray * getBOUserlist()
Get breakout meeting user list.
NSString * getBOName()
Get breakout meeting nmae.
ZoomSDKBOStopCountDown countDown
Set the countdown after closing breakout room.
BOOL isAutoMoveAllAssignedParticipantsEnabled
Enable/Disable that auto move all assigned participants to breakout room.
BOOL isTimerAutoStopBOEnabled
YES means time is up, will stop BO auto, otherwise not.
BOOL isParticipantCanReturnToMainSessionAtAnyTime
Enable/Disable that participant can return to main session at any time.
unsigned int nTimerDuration
Seconds of BO timer duration, NOTE: when nTimerDuration is 0, it means that the BO duration is 30*60 ...
BOOL isParticipantCanChooseBO
Enable/Disable that participant can choose breakout room.
BOOL isBOTimerEnabled
YES means it's timer BO ,otherwise not.