Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKQAController Class Reference

#include <ZoomSDKQAController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isQAEnable
 Q&A function is available.
 
(NSArray *_Nullable) - getAllQuestionList
 Get all question list.
 
(NSArray *_Nullable) - getMyQuestionList
 Get my question list.
 
(NSArray *_Nullable) - getOpenQuestionList
 Get open question list.
 
(NSArray *_Nullable) - getDismissedQuestionList
 Get dismissed question list.
 
(NSArray *_Nullable) - getAnsweredQuestionList
 Get anwered question list.
 
(ZoomSDKError- addQuestionWithQuestionContent:isAnonymous:
 Attendee to send question.
 
(ZoomSDKError- answerQuestionPrivateWithQuestionID:answerContent:
 Answer questions in private.
 
(ZoomSDKError- answerQuestionPublicWithQuestionID:answerContent:
 Answer questions in public.
 
(ZoomSDKError- dismissQuestionWithQuestionID:
 Dismiss question.
 
(ZoomSDKError- reopenQuestionWithQuestionID:
 Reopen the question.
 
(ZoomSDKError- commentQuestionWithQuestionID:commentContent:
 Comment the question.
 
(ZoomSDKError- voteupQuestionWithQuestionID:isEableVokeup:
 Vote the question.
 
(ZoomSDKError- enableAskQuestion:
 Set attendee can ask question.
 
(ZoomSDKError- enableAnonymousSendQuestion:
 Set attendee can anonnymous send question.
 
(ZoomSDKError- enableQAComment:
 Set attendee comment.
 
(ZoomSDKError- enableQAVoteup:
 Set attendee vote.
 
(ZoomSDKError- setAttendeeViewQuestionType:
 Set attendee view question type.
 
(ZoomSDKQuestionInfo *) - getQuestionByQuestionID:
 Get the question object.
 
(BOOL) - isAskQuestionEnabled
 Determine if the ask question is allowed by the host/co-host.
 
(BOOL) - isQAVoteupEnable
 Determine if the Q&A vote is allowed by the host/co-host.
 
(BOOL) - isQACommentEnabled
 Determine if the Q&A comment is allowed by the host/co-host.
 
(BOOL) - isAllowAskQuestionAnonymously
 Determine if the ask question anonymous is allowed by the host/co-host.
 
(BOOL) - isAttendeeCanViewAllQuestions
 Determine if the Q&A attendee can view all question.
 
(ZoomSDKAnswerInfo *) - getAnswerByAnswerID:
 Get the answer object.
 
(ZoomSDKError- startLiving:
 Start answer question on living.
 
(ZoomSDKError- endLiving:
 End answer question on living.
 
(int) - getOpenQuestionCount
 Get open question count.
 
(int) - getDismissedQuestionCount
 Get dismiss question count.
 
(int) - getAnsweredQuestionCount
 Get answered question count.
 
(int) - getMyQuestionCount
 Get my question count.
 
(ZoomSDKError- deleteQuestion:
 Deleted question.
 
(ZoomSDKError- deleteAnswer:
 Deleted answer.
 
(BOOL) - isQALegalNoticeAvailable
 Determine whether the legal notice for QA is available.
 
(NSString *) - getQALegalNoticesPrompt
 Get the QA legal notices prompt.
 
(NSString *) - getQALegalNoticesExplained
 Get the QA legal notices explained.
 

Protected Attributes

id< ZoomSDKQAControllerDelegate_delegate
 

Properties

id< ZoomSDKQAControllerDelegatedelegate
 

Detailed Description

Definition at line 271 of file ZoomSDKQAController.h.

Method Documentation

◆ addQuestionWithQuestionContent:isAnonymous:

- (ZoomSDKError) addQuestionWithQuestionContent: (NSString *) content
isAnonymous: (BOOL) Anonymous 

Attendee to send question.

Parameters
contentThe question content of user send.
AnonymousIf YES means can anonymous send question.Otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ answerQuestionPrivateWithQuestionID:answerContent:

- (ZoomSDKError) answerQuestionPrivateWithQuestionID: (NSString *) questionID
answerContent: (NSString *) content 

Answer questions in private.

Parameters
questionIDThe answer question ID.
contentThe answer content.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ answerQuestionPublicWithQuestionID:answerContent:

- (ZoomSDKError) answerQuestionPublicWithQuestionID: (NSString *) questionID
answerContent: (NSString *) content 

Answer questions in public.

Parameters
questionIDThe answer question ID.
contentThe answer content.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ commentQuestionWithQuestionID:commentContent:

- (ZoomSDKError) commentQuestionWithQuestionID: (NSString *) questionID
commentContent: (NSString *) content 

Comment the question.

Parameters
questionIDThe comment question ID.
contentThe comment on the content.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ deleteAnswer:

- (ZoomSDKError) deleteAnswer: (NSString *) answerID

Deleted answer.

Parameters
answerIDThe ID of answer.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ deleteQuestion:

- (ZoomSDKError) deleteQuestion: (NSString *) questionID

Deleted question.

Parameters
questionIDThe ID of question.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ dismissQuestionWithQuestionID:

- (ZoomSDKError) dismissQuestionWithQuestionID: (NSString *) questionID

Dismiss question.

Parameters
questionIDThe dismiss question is;
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableAnonymousSendQuestion:

- (ZoomSDKError) enableAnonymousSendQuestion: (BOOL) enable

Set attendee can anonnymous send question.

Parameters
enableIf set YES means attendee can anonnymous send question,Otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableAskQuestion:

- (ZoomSDKError) enableAskQuestion: (BOOL) enable

Set attendee can ask question.

Parameters
enableIf set YES means attendee can ask question,Otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableQAComment:

- (ZoomSDKError) enableQAComment: (BOOL) enable

Set attendee comment.

Parameters
enableIf set YES means attendee can comment,Otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableQAVoteup:

- (ZoomSDKError) enableQAVoteup: (BOOL) enable

Set attendee vote.

Parameters
enableIf set YES means attendee can vote,Otherwise not.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ endLiving:

- (ZoomSDKError) endLiving: (NSString *) questionId

End answer question on living.

Parameters
questionIdThe ID of question.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ getAllQuestionList

- (NSArray *_Nullable) getAllQuestionList

Get all question list.

Returns
If the function succeeds, the return value is array of all question.

◆ getAnswerByAnswerID:

- (ZoomSDKAnswerInfo *) getAnswerByAnswerID: (NSString *) answerID

Get the answer object.

Parameters
answerIDThe ID of answer.
Returns
If the function succeeds, the return value is answer object.

◆ getAnsweredQuestionCount

- (int) getAnsweredQuestionCount

Get answered question count.

Returns
Value is the answered question count.

◆ getAnsweredQuestionList

- (NSArray *_Nullable) getAnsweredQuestionList

Get anwered question list.

Returns
If the function succeeds, the return value is array of answered question.

◆ getDismissedQuestionCount

- (int) getDismissedQuestionCount

Get dismiss question count.

Returns
Value is the dismiss question count.

◆ getDismissedQuestionList

- (NSArray *_Nullable) getDismissedQuestionList

Get dismissed question list.

Returns
If the function succeeds, the return value is array of dismissed question.

◆ getMyQuestionCount

- (int) getMyQuestionCount

Get my question count.

Returns
Value is the my question count.

◆ getMyQuestionList

- (NSArray *_Nullable) getMyQuestionList

Get my question list.

Returns
If the function succeeds, the return value is array of my question.

◆ getOpenQuestionCount

- (int) getOpenQuestionCount

Get open question count.

Returns
Value is the open question count.

◆ getOpenQuestionList

- (NSArray *_Nullable) getOpenQuestionList

Get open question list.

Returns
If the function succeeds, the return value is array of open question.

◆ getQALegalNoticesExplained

- (NSString *) getQALegalNoticesExplained

Get the QA legal notices explained.

Returns
If the function succeeds, it will return the QA legal notices explained. Otherwise nil.

◆ getQALegalNoticesPrompt

- (NSString *) getQALegalNoticesPrompt

Get the QA legal notices prompt.

Returns
If the function succeeds, it will return the QA legal notices prompt. Otherwise nil.

◆ getQuestionByQuestionID:

- (ZoomSDKQuestionInfo *) getQuestionByQuestionID: (NSString *) questionID

Get the question object.

Parameters
questionIDThe ID of question.
Returns
If the function succeeds, the return value is question object.

◆ isAllowAskQuestionAnonymously

- (BOOL) isAllowAskQuestionAnonymously

Determine if the ask question anonymous is allowed by the host/co-host.

Returns
If return YES means can ask question anonymously,otherwise not.

◆ isAskQuestionEnabled

- (BOOL) isAskQuestionEnabled

Determine if the ask question is allowed by the host/co-host.

Returns
If return YES means can ask question,otherwise not.

◆ isAttendeeCanViewAllQuestions

- (BOOL) isAttendeeCanViewAllQuestions

Determine if the Q&A attendee can view all question.

Returns
If return YES means attendee can view all queation,otherwise not.

◆ isQACommentEnabled

- (BOOL) isQACommentEnabled

Determine if the Q&A comment is allowed by the host/co-host.

Returns
If return YES means can commeent,otherwise not.

◆ isQAEnable

- (BOOL) isQAEnable

Q&A function is available.

Returns
If return YES means Q&A is available,otherwise not.

◆ isQALegalNoticeAvailable

- (BOOL) isQALegalNoticeAvailable

Determine whether the legal notice for QA is available.

Returns
YES indicates the legal notice for QA is available. Otherwise not.

◆ isQAVoteupEnable

- (BOOL) isQAVoteupEnable

Determine if the Q&A vote is allowed by the host/co-host.

Returns
If return YES means can vote,otherwise not.

◆ reopenQuestionWithQuestionID:

- (ZoomSDKError) reopenQuestionWithQuestionID: (NSString *) questionID

Reopen the question.

Parameters
questionIDThe reopen question is.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ setAttendeeViewQuestionType:

- (ZoomSDKError) setAttendeeViewQuestionType: (AttendeeViewQuestionType) type

Set attendee view question type.

Parameters
typeThe enumeration of AttendeeViewQuestionType,if type is viewType_OnlyAnswered_Question,attendee only view the answered question,if type is viewType_All_Question,attendee can view all question
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ startLiving:

- (ZoomSDKError) startLiving: (NSString *) questionId

Start answer question on living.

Parameters
questionIdThe ID of question.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ voteupQuestionWithQuestionID:isEableVokeup:

- (ZoomSDKError) voteupQuestionWithQuestionID: (NSString *) questionID
isEableVokeup: (BOOL) enable 

Vote the question.

Parameters
questionIDThe vote question ID.
enableIf YES means vote the question,otherwise cancel vote.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Field Documentation

◆ _delegate

- (id<ZoomSDKQAControllerDelegate>) _delegate
protected

Definition at line 273 of file ZoomSDKQAController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKQAControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 275 of file ZoomSDKQAController.h.