Mac SDK
ZoomSDKNewBreakoutRoomController.h
1 
2 #import <Foundation/Foundation.h>
3 #import "ZoomSDKErrors.h"
4 
5 NS_ASSUME_NONNULL_BEGIN
6 @interface ZoomSDKBOMeetingInfo : NSObject
7 
12 -(NSString *)getBOID;
13 
18 -(NSString *)getBOName;
19 
24 -(NSArray *)getBOUserlist;
25 @end
26 
27 
28 @interface ZoomSDKBOMeetingCreator : NSObject
29 
35 -(NSString *)createBOWithBOName:(NSString*)name;
36 
43 -(ZoomSDKError)updateBOName:(NSString*)newName BOID:(NSString *)ID;
44 
50 -(ZoomSDKError)removeBO:(NSString*)BOID;
51 
58 -(ZoomSDKError)assignUserToBO:(NSString *)userID BOID:(NSString *)ID;
59 
66 -(ZoomSDKError)removeUserFromBO:(NSString *)userID BOID:(NSString *)ID;
67 @end
68 
69 @protocol ZoomSDKBOMeetingAdminDelegate <NSObject>
70 @optional
75 -(void)onHelpRequestReceived:(NSString *)userID;
76 @end
77 
78 @interface ZoomSDKBOMeetingAdmin : NSObject
79 
80 @property(nonatomic,assign)id<ZoomSDKBOMeetingAdminDelegate> delegate;
85 -(ZoomSDKError)startBO;
86 
91 -(ZoomSDKError)stopBO;
92 
99 -(ZoomSDKError)assignNewUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
100 
107 -(ZoomSDKError)switchAssignedUserToRunningBO:(NSString *)userID BOID:(NSString *)ID;
108 
113 -(BOOL)canStartBO;
114 
120 -(ZoomSDKError)joinBOByUserRequest:(NSString *)requestUserID;
121 
127 -(ZoomSDKError)ignoreUserHelpRequest:(NSString *)userID;
128 
134 -(ZoomSDKError)broadcastMessage:(NSString *)message;
135 @end
136 
137 @interface ZoomSDKBOMeetingAssistant : NSObject
138 
144 -(ZoomSDKError)joinBO:(NSString*)ID;
145 
150 -(ZoomSDKError)leaveBO;
151 @end
152 
154 @optional
159 -(void)onHelpRequestHandleResultReceived:(ZoomSDKRequest4HelpResult)result;
160 
165 
170 
171 @end
172 
173 @interface ZoomSDKBOMeetingAttendee : NSObject
174 
175 @property(nonatomic,assign)id<ZoomSDKBOMeetingAttendeeDelegate> delegate;
180 -(ZoomSDKError)joinBO;
181 
186 -(ZoomSDKError)leaveBO;
187 
192 -(NSString*)getBOName;
193 
198 -(ZoomSDKError)requestForHelp;
199 
204 -(BOOL)isHostInThisBO;
205 @end
206 
208 @optional
209 
214 -(void)onBOMeetingInfoUpdata:(NSString *)boID;
215 
220 @end
221 
222 @interface ZoomSDKBOMeetingDataHelp : NSObject
223 
227 @property(nonatomic,assign)id<ZoomSDKBOMeetingDataHelpDelegate> delegate;
228 
233 -(NSArray *)getUnassignedUserList;
234 
239 -(NSArray *)getBOMeetingIDList;
240 
246 -(NSString *)getBOUserNameWithUserID:(NSString *)userID;
247 
253 -(ZoomSDKBOUserStatus)getBOUserStatusWithUserID:(NSString *)userID;
254 
260 -(ZoomSDKBOMeetingInfo *)getBOMeetingInfoWithBOID:(NSString *)BOID;
261 
267 -(BOOL)isMyselfInBo:(NSString *)userid;
268 
273 -(NSString*)getCurrentBoName;
274 @end
275 
276 
278 @optional
279 
284 -(void)onHasCreatorPermission:(ZoomSDKBOMeetingCreator *)creatorObject;
285 
290 -(void)onHasAdminPermission:(ZoomSDKBOMeetingAdmin *)adminObject;
291 
296 -(void)onHasAssistantPermission:(ZoomSDKBOMeetingAssistant *)assistantObject;
297 
302 -(void)onHasAttendeePermission:(ZoomSDKBOMeetingAttendee *)attendeeObject;
303 
308 -(void)onHasDataHelperPermission:(ZoomSDKBOMeetingDataHelp *)dataHelpObject;
309 
314 
318 -(void)onLostAdminPermission;
319 
324 
329 
334 
339 -(void)onNewBroadcastMessageReceived:(NSString *)message;
340 @end
341 
342 @interface ZoomSDKNewBreakoutRoomController : NSObject
343 
344 @property(nonatomic,assign)id<ZoomSDKNewBreakoutRoomControllerDelegate> delegate;
345 
351 -(ZoomSDKBOMeetingCreator *)getBOMeetingCreator;
352 
358 -(ZoomSDKBOMeetingAdmin *)getBOMeetingAdmin;
359 
365 -(ZoomSDKBOMeetingAssistant *)getBOMeetingAssistant;
366 
372 -(ZoomSDKBOMeetingAttendee *)getBOMeetingAttendee;
373 
379 -(ZoomSDKBOMeetingDataHelp *)getBOMeetingDataHelp;
380 
385 -(BOOL)isBOStart;
386 
391 -(BOOL)isBOEnable;
392 
397 -(BOOL)isInBOMeeting;
398 @end
399 
400 NS_ASSUME_NONNULL_END
-[ZoomSDKNewBreakoutRoomControllerDelegate-p onLostAttendeePermission]
void onLostAttendeePermission()
If lost attendee's permissions change,will receive the callback.
ZoomSDKBOMeetingDataHelpDelegate-p
Definition: ZoomSDKNewBreakoutRoomController.h:207
-[ZoomSDKBOMeetingInfo getBOName]
NSString * getBOName()
Get breakout meeting nmae.
-[ZoomSDKNewBreakoutRoomControllerDelegate-p onLostAdminPermission]
void onLostAdminPermission()
If lost admin's permissions change,will receive the callback.
-[ZoomSDKBOMeetingAssistant leaveBO]
ZoomSDKError leaveBO()
Leave Breakout meeting.
-[ZoomSDKBOMeetingAdmin canStartBO]
BOOL canStartBO()
Determine if the user can start breakout room.
ZoomSDKBOMeetingAssistant
Definition: ZoomSDKNewBreakoutRoomController.h:138
-[ZoomSDKBOMeetingAttendeeDelegate-p onHostLeaveThisBOMeeting]
void onHostLeaveThisBOMeeting()
Notify the host leave current breakout room.
-[ZoomSDKBOMeetingAdmin startBO]
ZoomSDKError startBO()
Start breakout meeting.
-[ZoomSDKNewBreakoutRoomControllerDelegate-p onLostAssistantPermission]
void onLostAssistantPermission()
If lost assistant's permissions change,will receive the callback.
ZoomSDKBOMeetingAttendee
Definition: ZoomSDKNewBreakoutRoomController.h:174
-[ZoomSDKBOMeetingAttendeeDelegate-p onHostJoinedThisBOMeeting]
void onHostJoinedThisBOMeeting()
Notify the host join current breakout room.
ZoomSDKBOMeetingAttendeeDelegate-p
Definition: ZoomSDKNewBreakoutRoomController.h:153
ZoomSDKBOMeetingInfo
Definition: ZoomSDKNewBreakoutRoomController.h:7
ZoomSDKNewBreakoutRoomController
Definition: ZoomSDKNewBreakoutRoomController.h:343
-[ZoomSDKBOMeetingInfo getBOID]
NSString * getBOID()
Get breakout meeting id.
ZoomSDKBOMeetingAdmin
Definition: ZoomSDKNewBreakoutRoomController.h:79
ZoomSDKNewBreakoutRoomControllerDelegate-p
Definition: ZoomSDKNewBreakoutRoomController.h:277
-[ZoomSDKNewBreakoutRoomControllerDelegate-p onLostCreatorPermission]
void onLostCreatorPermission()
If lost creator's permissions change,will receive the callback.
-[ZoomSDKBOMeetingDataHelpDelegate-p onUnAssignedUserUpdated]
void onUnAssignedUserUpdated()
If the unassigned user chanaged,will receive the callback.
-[ZoomSDKNewBreakoutRoomControllerDelegate-p onLostDataHelperPermission]
void onLostDataHelperPermission()
If lost dataHelper's permissions change,will receive the callback.
ZoomSDKBOMeetingCreator
Definition: ZoomSDKNewBreakoutRoomController.h:29
ZoomSDKBOMeetingAdminDelegate-p
Definition: ZoomSDKNewBreakoutRoomController.h:69
-[ZoomSDKBOMeetingAdmin stopBO]
ZoomSDKError stopBO()
Stop breakout meeting.
ZoomSDKBOMeetingDataHelp
Definition: ZoomSDKNewBreakoutRoomController.h:223
-[ZoomSDKBOMeetingInfo getBOUserlist]
NSArray * getBOUserlist()
Get breakout meeting user list.