Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKQAController.h
Go to the documentation of this file.
1
8#import <Foundation/Foundation.h>
9#import <ZoomSDK/ZoomSDKErrors.h>
10
11NS_ASSUME_NONNULL_BEGIN
16@interface ZoomSDKAnswerInfo :NSObject
21- (NSString*_Nullable)getAnswerID;
22
27- (BOOL)isSenderMyself;
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
63- (BOOL)isLiveAnswer;
64@end
65
70@interface ZoomSDKQuestionInfo : NSObject
71
76- (NSString*_Nullable)getQuestionId;
81- (BOOL)isSenderMyself;
82
87- (time_t )getTimeStamp;
88
93- (NSString*_Nullable)getQuestionContent;
94
99- (NSString*_Nullable)getSendName;
100
105- (BOOL)isAnonymous;
106
111- (BOOL)isMarkedAsAnswered;
112
117- (BOOL)isMarkedAsDismissed;
118
123- (int)upVoteNum;
124
129- (BOOL)hasLiveAnswers;
130
135- (BOOL)hasTextAnswers;
136
141- (BOOL)isMySelfUpvoted;
142
147- (BOOL)amILiveAnswering;
148
153- (NSArray*_Nullable)getAnswerList;
154
159- (NSString*_Nullable)getLiveAnswerName;
160
165- (BOOL)isLiveAnswering;
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
306- (BOOL)isQAEnable;
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
436- (BOOL)isAskQuestionEnabled;
441- (BOOL)isQAVoteupEnable;
442
447- (BOOL)isQACommentEnabled;
448
453- (BOOL)isAllowAskQuestionAnonymously;
454
459- (BOOL)isAttendeeCanViewAllQuestions;
460
466- (ZoomSDKAnswerInfo *)getAnswerByAnswerID:(NSString *)answerID;
467
473- (ZoomSDKError)startLiving:(NSString *)questionId;
474
480- (ZoomSDKError)endLiving:(NSString *)questionId;
481
486- (int)getOpenQuestionCount;
487
492- (int)getDismissedQuestionCount;
493
498- (int)getAnsweredQuestionCount;
499
504- (int)getMyQuestionCount;
505
511- (ZoomSDKError)deleteQuestion:(NSString *)questionID;
512
518- (ZoomSDKError)deleteAnswer:(NSString *)answerID;
519
524- (BOOL)isQALegalNoticeAvailable;
525
530- (NSString *)getQALegalNoticesPrompt;
531
536- (NSString *)getQALegalNoticesExplained;
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()
Get the answer ID.
BOOL isLiveAnswer()
Get the answer is live.
time_t getTimeStamp()
Get the timestamps of the current answer.
NSString *_Nullable getAnswerContent()
Get the answer content.
BOOL isSenderMyself()
Get the question answer is send myself.
NSString *_Nullable getQuestionId()
Get the question ID.
BOOL isPrivate()
Get the answer is private.
NSString *_Nullable getSendName()
Get the senderName of the send answer.
Provide interfaces to manage Q&A session in Zoom meeting.
id< ZoomSDKQAControllerDelegate > _delegate
Represents a question object in the Q&A module.
BOOL isMarkedAsDismissed()
Get the question is marked as dismissed.
NSString *_Nullable getLiveAnswerName()
Get the person name of live answered question.
BOOL hasLiveAnswers()
Get the question has live answer.
BOOL isAnonymous()
Get the question is anonymous.
BOOL isLiveAnswering()
Get the queestion is answered living.
BOOL isMarkedAsAnswered()
Get the question is marked as answer.
BOOL isMySelfUpvoted()
Get the question is myself vote.
BOOL hasTextAnswers()
Get the question has text answer.
BOOL amILiveAnswering()
Get the question is myself live answered.
NSArray *_Nullable getAnswerList()
Get the question answer list.
NSString *_Nullable getSendName()
Get the senderName of the send question.
NSString *_Nullable getQuestionContent()
Get the question content.
BOOL isSenderMyself()
Get the question is send by self.
NSString *_Nullable getQuestionId()
Get the question ID.
time_t getTimeStamp()
Get the timestamps of the current question.
int upVoteNum()
Get the question vote number.