Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKWaitingRoomController.h
Go to the documentation of this file.
1
2NS_ASSUME_NONNULL_BEGIN
3@class ZoomSDKUserInfo;
4
9@property(retain, nonatomic, readonly,nullable)NSColor* backgroundColor;
10@end
11
16@property(retain, nonatomic, readonly, nullable)NSColor* primaryColor;
20@property(retain, nonatomic, readonly,nullable)NSColor* secondaryColor;
24@property(retain, nonatomic, readonly,nullable)NSColor* paragraphColor;
28@property(retain, nonatomic, readonly,nullable)NSColor* hyperlinkColor;
29@end
30
35@property(retain, nonatomic, readonly,nullable)NSColor* primaryButtonColor;
36@end
37
38@interface ZoomSDKCustomWaitingRoomData : NSObject
42@property (copy, nonatomic, readonly, nullable) NSString* title;
46@property (copy, nonatomic, readonly, nullable) NSString* dataDescription;
50@property (copy, nonatomic, readonly, nullable) NSString* logoPath;
54@property (copy, nonatomic, readonly, nullable) NSString* videoPath;
58@property (copy, nonatomic, readonly, nullable) NSString* imagePath;
62@property (assign, nonatomic, readonly) ZoomSDKWaitingRoomLayoutType type;
66@property (assign, nonatomic, readonly) ZoomSDKCustomWaitingRoomDataStatus status;
70@property (retain, nonatomic, readonly) ZoomSDKWaitingRoomBrandingPageColor* pageColor;
74@property (retain, nonatomic, readonly) ZoomSDKWaitingRoomBrandingTextColor* textColor;
78@property (retain, nonatomic, readonly) ZoomSDKWaitingRoomBrandingButtonColor* buttonColor;
79@end
80
81
89- (void)retry;
93- (void)ignore;
94@end
95
96
97
98@protocol ZoomSDKWaitingRoomDelegate <NSObject>
103- (void)onUserJoinWaitingRoom:(unsigned int)userid;
108- (void)onUserLeftWaitingRoom:(unsigned int)userid;
109
114- (void)onWaitingRoomPresetAudioStatusChanged:(BOOL)audioCanTurnOn;
115
120- (void)onWaitingRoomPresetVideoStatusChanged:(BOOL)videoCanTurnOn;
121
127- (void)onCustomWaitingRoomDataUpdated:(ZoomSDKCustomWaitingRoomData*_Nullable)bData handle:(ZoomSDKWaitingRoomDataDownloadHandler*_Nullable)handle;
128
134- (void)onWaitingRoomUserNameChanged:(unsigned int)userID userName:(NSString *)userName;
135
140- (void)onWaitingRoomEntranceEnabled:(BOOL)enabled;
141@end
142
143@interface ZoomSDKWaitingRoomController : NSObject
144{
145 id<ZoomSDKWaitingRoomDelegate> _delegate;
146}
147@property (assign, nonatomic, nullable) id<ZoomSDKWaitingRoomDelegate> delegate;
152- (BOOL)isSupportWaitingRoom;
153
158- (BOOL)isWaitingRoomOnEntryLocked;
159
164- (BOOL)isEnableWaitingRoomOnEntry;
170- (ZoomSDKError)enableWaitingRoomOnEntry:(BOOL)enable;
175- (NSArray*_Nullable)getWaitRoomUserList;
181- (ZoomSDKUserInfo*_Nullable)getWaitingRoomUserInfo:(unsigned int)userid;
187- (ZoomSDKError)admitToMeeting:(unsigned int)userid;
188
193- (ZoomSDKError)admitAllToMeeting;
194
200- (ZoomSDKError)putIntoWaitingRoom:(unsigned int)userid;
201
206- (BOOL)isAudioEnabledInWaitingRoom;
207
212- (BOOL)isVideoEnabledInWaitingRoom;
213
218- (ZoomSDKError)requestCustomWaitingRoomData;
219
224- (BOOL)canRenameUser;
225
232- (ZoomSDKError)renameUser:(unsigned int)userID newUserName:(NSString *)userName;
233
238- (BOOL)canExpelUser;
239
245- (ZoomSDKError)expelUser:(unsigned int)userID;
246@end
247NS_ASSUME_NONNULL_END
ZoomSDKCustomWaitingRoomDataStatus
Enumeration of the status of custom waiting room data.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKWaitingRoomLayoutType
Enumeration of waiting room layout type. For more information, please visit https://support....
ZOOM SDK user information.
NSColor * backgroundColor
The background color.
id< ZoomSDKWaitingRoomDelegate > _delegate
Handler to download waiting room customize data if download fail.