Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKQAController.h
Go to the documentation of this file.
1
7
8#import <Foundation/Foundation.h>
9#import <ZoomSDK/ZoomSDKErrors.h>
10
11NS_ASSUME_NONNULL_BEGIN
16@interface ZoomSDKAnswerInfo :NSObject
21- (NSString*_Nullable)getAnswerID;
22
28
33- (time_t)getTimeStamp;
34
39- (NSString*_Nullable)getAnswerContent;
40
45- (NSString*_Nullable)getSendName;
46
51- (NSString*_Nullable)getQuestionId;
52
57- (BOOL)isPrivate;
58
64@end
65
70@interface ZoomSDKQuestionInfo : NSObject
71
76- (NSString*_Nullable)getQuestionId;
82
87- (time_t )getTimeStamp;
88
93- (NSString*_Nullable)getQuestionContent;
94
99- (NSString*_Nullable)getSendName;
100
106
112
118
124
130
136
142
148
153- (NSArray*_Nullable)getAnswerList;
154
159- (NSString*_Nullable)getLiveAnswerName;
160
166@end
167
168
173@protocol ZoomSDKQAControllerDelegate <NSObject>
174
179- (void)onQAConnectStatus:(ZoomSDKQAConnectStatus)status;
180
186- (void)onAddQuestion:(NSString *)questionID isSuccess:(BOOL)success;
187
193- (void)onAddAnswer:(NSString *)answerID isSuccess:(BOOL)success;
194
199- (void)onQuestionMarkedAsDismissed:(NSString*)questionID;
200
205- (void)onReopenQuestion:(NSString*)questionID;
206
211- (void)onReceiveQuestion:(NSString*_Nullable)questionID;
212
217- (void)onReceiveAnswer:(NSString*_Nullable)answerID;
218
223- (void)onUserLivingReply:(NSString*)questionID;
224
229- (void)onUserEndLiving:(NSString*)questionID;
230
236- (void)onVoteupQuestion:(NSString*)questionID orderChanged:(BOOL)isChanged;
237
243- (void)onRevokeVoteupQuestion:(NSString*)questionID orderChanged:(BOOL)isChanged;
244
249- (void)onAllowAskQuestionStatus:(BOOL)bEnabled;
250
255- (void)onAllowAskQuestionAnonymousStatus:(BOOL)bEnabled;
256
261- (void)onAllowAttendeeViewAllQuestionStatus:(BOOL)bEnabled;
262
267- (void)onAllowAttendeeVoteupQuestionStatus:(BOOL)bEnabled;
268
273- (void)onAllowAttendeeCommentQuestionStatus:(BOOL)bEnabled;
274
279- (void)onDeleteQuestions:(NSArray *)questions;
280
285- (void)onDeleteAnswers:(NSArray *)answer;
286@end
287
288
293@interface ZoomSDKQAController : NSObject
294{
295 id<ZoomSDKQAControllerDelegate> _delegate;
296}
300@property(nonatomic,assign,nullable)id<ZoomSDKQAControllerDelegate> delegate;
301
311- (NSArray*_Nullable)getAllQuestionList;
312
317- (NSArray*_Nullable)getMyQuestionList;
318
323- (NSArray*_Nullable)getOpenQuestionList;
324
329- (NSArray*_Nullable)getDismissedQuestionList;
330
335- (NSArray*_Nullable)getAnsweredQuestionList;
336
343- (ZoomSDKError)addQuestionWithQuestionContent:(NSString*)content isAnonymous:(BOOL)Anonymous;
344
351- (ZoomSDKError)answerQuestionPrivateWithQuestionID:(NSString*)questionID answerContent:(NSString*)content;
352
359- (ZoomSDKError)answerQuestionPublicWithQuestionID:(NSString*)questionID answerContent:(NSString*)content;
360
366- (ZoomSDKError)dismissQuestionWithQuestionID:(NSString*)questionID;
367
373- (ZoomSDKError)reopenQuestionWithQuestionID:(NSString*)questionID;
374
381- (ZoomSDKError)commentQuestionWithQuestionID:(NSString*)questionID commentContent:(NSString*)content;
382
389- (ZoomSDKError)voteupQuestionWithQuestionID:(NSString*)questionID isEableVokeup:(BOOL)enable;
390
396- (ZoomSDKError)enableAskQuestion:(BOOL)enable;
402- (ZoomSDKError)enableAnonymousSendQuestion:(BOOL)enable;
403
409- (ZoomSDKError)enableQAComment:(BOOL)enable;
410
416- (ZoomSDKError)enableQAVoteup:(BOOL)enable;
417
423- (ZoomSDKError)setAttendeeViewQuestionType:(AttendeeViewQuestionType)type;
424
430- (ZoomSDKQuestionInfo*)getQuestionByQuestionID:(NSString*)questionID;
431
442
448
454
460
466- (ZoomSDKAnswerInfo *)getAnswerByAnswerID:(NSString *)answerID;
467
473- (ZoomSDKError)startLiving:(NSString *)questionId;
474
480- (ZoomSDKError)endLiving:(NSString *)questionId;
481
487
493
499
505
511- (ZoomSDKError)deleteQuestion:(NSString *)questionID;
512
518- (ZoomSDKError)deleteAnswer:(NSString *)answerID;
519
525
531
537@end
538NS_ASSUME_NONNULL_END
ZoomSDKQAConnectStatus
Enumeration of Q&A connection statuses.
AttendeeViewQuestionType
Enumeration of attendee view question type.
ZoomSDKError
Enumeration of common errors of SDK.
Represents an answer object in the Q&A module.
NSString *_Nullable getAnswerID()
Gets the answer ID.
BOOL isLiveAnswer()
Gets the answer is live.
time_t getTimeStamp()
Gets the current answer's timestamps.
NSString *_Nullable getAnswerContent()
Gets the answer content.
BOOL isSenderMyself()
Gets the question answer is send myself.
NSString *_Nullable getQuestionId()
Gets the question ID.
BOOL isPrivate()
Gets the answer is private.
NSString *_Nullable getSendName()
Gets the answer's sender name.
Provide interfaces to manage Q&A session in Zoom meeting.
NSString * getQALegalNoticesExplained()
Gets the QA legal notices explained.
NSArray *_Nullable getMyQuestionList()
Gets my question list.
id< ZoomSDKQAControllerDelegate > delegate
Delegate to receive Q&A-related callback events.
NSArray *_Nullable getOpenQuestionList()
Gets open question list.
BOOL isAllowAskQuestionAnonymously()
Determines if the ask question anonymous is allowed by the host or co-host.
id< ZoomSDKQAControllerDelegate > _delegate
BOOL isQAEnable()
Q&A function is available.
BOOL isAskQuestionEnabled()
Determines if the ask question is allowed by the host or co-host.
NSString * getQALegalNoticesPrompt()
Gets the QA legal notices prompt.
NSArray *_Nullable getAllQuestionList()
Gets all question list.
NSArray *_Nullable getAnsweredQuestionList()
Gets anwered question list.
BOOL isQAVoteupEnable()
Determines if the Q&A vote is allowed by the host or co-host.
BOOL isAttendeeCanViewAllQuestions()
Determines if the Q&A attendee can view all question.
BOOL isQALegalNoticeAvailable()
Determines whether the legal notice for QA is available.
NSArray *_Nullable getDismissedQuestionList()
Gets dismissed question list.
int getDismissedQuestionCount()
Gets dismiss question count.
int getMyQuestionCount()
Gets my question count.
int getAnsweredQuestionCount()
Gets answered question count.
BOOL isQACommentEnabled()
Determines if the Q&A comment is allowed by the host or co-host.
int getOpenQuestionCount()
Gets open question count.
Represents a question object in the Q&A module.
BOOL isMarkedAsDismissed()
Gets the question is marked as dismissed.
NSString *_Nullable getLiveAnswerName()
Gets the person name of live answered question.
BOOL hasLiveAnswers()
Gets the question has live answer.
BOOL isAnonymous()
Gets the question is anonymous.
BOOL isLiveAnswering()
Gets the queestion is answered living.
BOOL isMarkedAsAnswered()
Gets the question is marked as answer.
BOOL isMySelfUpvoted()
Gets the question is myself vote.
BOOL hasTextAnswers()
Gets the question has text answer.
BOOL amILiveAnswering()
Gets the question is myself live answered.
NSArray *_Nullable getAnswerList()
Gets the question answer list.
NSString *_Nullable getSendName()
Gets the question's sender name.
NSString *_Nullable getQuestionContent()
Gets the question content.
BOOL isSenderMyself()
Gets the question is send by self.
NSString *_Nullable getQuestionId()
Gets the question ID.
time_t getTimeStamp()
Gets the current question's timestamps.
int upVoteNum()
Gets the question vote number.