Provide interfaces to manage Q&A session in Zoom meeting. More...

#include <ZoomSDKQAController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isQAEnable
	Q&A function is available.

(NSArray *_Nullable)	- getAllQuestionList
	Gets all question list.

(NSArray *_Nullable)	- getMyQuestionList
	Gets my question list.

(NSArray *_Nullable)	- getOpenQuestionList
	Gets open question list.

(NSArray *_Nullable)	- getDismissedQuestionList
	Gets dismissed question list.

(NSArray *_Nullable)	- getAnsweredQuestionList
	Gets 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:
	Sets attendee can ask question.

(ZoomSDKError)	- enableAnonymousSendQuestion:
	Sets attendee can anonnymous send question.

(ZoomSDKError)	- enableQAComment:
	Sets attendee comment.

(ZoomSDKError)	- enableQAVoteup:
	Sets attendee vote.

(ZoomSDKError)	- setAttendeeViewQuestionType:
	Sets attendee view question type.

(ZoomSDKQuestionInfo *)	- getQuestionByQuestionID:
	Gets the question object.

(BOOL)	- isAskQuestionEnabled
	Determines if the ask question is allowed by the host or co-host.

(BOOL)	- isQAVoteupEnable
	Determines if the Q&A vote is allowed by the host or co-host.

(BOOL)	- isQACommentEnabled
	Determines if the Q&A comment is allowed by the host or co-host.

(BOOL)	- isAllowAskQuestionAnonymously
	Determines if the ask question anonymous is allowed by the host or co-host.

(BOOL)	- isAttendeeCanViewAllQuestions
	Determines if the Q&A attendee can view all question.

(ZoomSDKAnswerInfo *)	- getAnswerByAnswerID:
	Gets the answer object.

(ZoomSDKError)	- startLiving:
	Starts answer question on living.

(ZoomSDKError)	- endLiving:
	End answer question on living.

(int)	- getOpenQuestionCount
	Gets open question count.

(int)	- getDismissedQuestionCount
	Gets dismiss question count.

(int)	- getAnsweredQuestionCount
	Gets answered question count.

(int)	- getMyQuestionCount
	Gets my question count.

(ZoomSDKError)	- deleteQuestion:
	Deleted question.

(ZoomSDKError)	- deleteAnswer:
	Deleted answer.

(BOOL)	- isQALegalNoticeAvailable
	Determines whether the legal notice for QA is available.

(NSString *)	- getQALegalNoticesPrompt
	Gets the QA legal notices prompt.

(NSString *)	- getQALegalNoticesExplained
	Gets the QA legal notices explained.

Protected Attributes
id< ZoomSDKQAControllerDelegate >	_delegate

Properties
id< ZoomSDKQAControllerDelegate >	delegate
	Delegate to receive Q&A-related callback events.

Detailed Description

Provide interfaces to manage Q&A session in Zoom meeting.

Definition at line 293 of file ZoomSDKQAController.h.

Method Documentation

◆ addQuestionWithQuestionContent:isAnonymous:

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

Attendee to send question.

Parameters

content	The question content of user send.
Anonymous	If YES means can anonymous send question, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ answerQuestionPrivateWithQuestionID:answerContent:

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

Answer questions in private.

Parameters

questionID	The answer question ID.
content	The answer content.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ answerQuestionPublicWithQuestionID:answerContent:

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

Answer questions in public.

Parameters

questionID	The answer question ID.
content	The answer content.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ commentQuestionWithQuestionID:commentContent:

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

Comment the question.

Parameters

questionID	The comment question ID.
content	The comment on the content.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ deleteAnswer:

- (ZoomSDKError) deleteAnswer: (NSString *) answerID

Deleted answer.

Parameters

answerID The ID of answer.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ deleteQuestion:

- (ZoomSDKError) deleteQuestion: (NSString *) questionID

Deleted question.

Parameters

questionID The ID of question.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ dismissQuestionWithQuestionID:

- (ZoomSDKError) dismissQuestionWithQuestionID: (NSString *) questionID

Dismiss question.

Parameters

questionID The dismiss question is;

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableAnonymousSendQuestion:

- (ZoomSDKError) enableAnonymousSendQuestion: (BOOL) enable

Sets attendee can anonnymous send question.

Parameters

enable If set YES means attendee can anonnymous send question, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableAskQuestion:

- (ZoomSDKError) enableAskQuestion: (BOOL) enable

Sets attendee can ask question.

Parameters

enable If set YES means attendee can ask question, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableQAComment:

- (ZoomSDKError) enableQAComment: (BOOL) enable

Sets attendee comment.

Parameters

enable If set YES means attendee can comment, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ enableQAVoteup:

- (ZoomSDKError) enableQAVoteup: (BOOL) enable

Sets attendee vote.

Parameters

enable If set YES means attendee can vote, NO otherwise.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ endLiving:

- (ZoomSDKError) endLiving: (NSString *) questionId

End answer question on living.

Parameters

questionId The ID of question.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getAllQuestionList

- (NSArray *_Nullable) getAllQuestionList

Gets all question list.

Returns: If the function succeeds, it returns array of all question. Otherwise, this function fails and returns nil.

◆ getAnswerByAnswerID:

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

Gets the answer object.

Parameters

answerID The ID of answer.

Returns: If the function succeeds, it returns answer object. Otherwise, this function fails and returns nil.

◆ getAnsweredQuestionCount

- (int) getAnsweredQuestionCount

Gets answered question count.

Returns: The answered question count.

◆ getAnsweredQuestionList

- (NSArray *_Nullable) getAnsweredQuestionList

Gets anwered question list.

Returns: If the function succeeds, it returns array of answered question. Otherwise, this function fails and returns nil.

◆ getDismissedQuestionCount

- (int) getDismissedQuestionCount

Gets dismiss question count.

Returns: The dismiss question count.

◆ getDismissedQuestionList

- (NSArray *_Nullable) getDismissedQuestionList

Gets dismissed question list.

Returns: If the function succeeds, it returns array of dismissed question. Otherwise, this function fails and returns nil.

◆ getMyQuestionCount

- (int) getMyQuestionCount

Gets my question count.

Returns: The my question count.

◆ getMyQuestionList

- (NSArray *_Nullable) getMyQuestionList

Gets my question list.

Returns: If the function succeeds, it returns array of my question. Otherwise, this function fails and returns nil.

◆ getOpenQuestionCount

- (int) getOpenQuestionCount

Gets open question count.

Returns: The open question count.

◆ getOpenQuestionList

- (NSArray *_Nullable) getOpenQuestionList

Gets open question list.

Returns: If the function succeeds, it returns array of open question. Otherwise, this function fails and returns nil.

◆ getQALegalNoticesExplained

- (NSString *) getQALegalNoticesExplained

Gets the QA legal notices explained.

Returns: If the function succeeds, it returns the QA legal notices explained. Otherwise, this function fails and returns nil.

◆ getQALegalNoticesPrompt

- (NSString *) getQALegalNoticesPrompt

Gets the QA legal notices prompt.

Returns: If the function succeeds, it returns the QA legal notices prompt. Otherwise, this function fails and returns nil.

◆ getQuestionByQuestionID:

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

Gets the question object.

Parameters

questionID The ID of question.

Returns: If the function succeeds, it returns question object. Otherwise, this function fails and returns nil.

◆ isAllowAskQuestionAnonymously

- (BOOL) isAllowAskQuestionAnonymously

Determines if the ask question anonymous is allowed by the host or co-host.

Returns: If return YES if can ask question anonymously. Otherwise, NO.

◆ isAskQuestionEnabled

- (BOOL) isAskQuestionEnabled

Determines if the ask question is allowed by the host or co-host.

Returns: If return YES if can ask question. Otherwise, NO.

◆ isAttendeeCanViewAllQuestions

- (BOOL) isAttendeeCanViewAllQuestions

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

Returns: If return YES if attendee can view all queation. Otherwise, NO.

◆ isQACommentEnabled

- (BOOL) isQACommentEnabled

Determines if the Q&A comment is allowed by the host or co-host.

Returns: If return YES if can comment. Otherwise, NO.

◆ isQAEnable

- (BOOL) isQAEnable

Q&A function is available.

Returns: If returns YES, Q&A is available. Otherwise, NO.

◆ isQALegalNoticeAvailable

- (BOOL) isQALegalNoticeAvailable

Determines whether the legal notice for QA is available.

Returns: YES if the legal notice for QA is available. Otherwise, NO.

◆ isQAVoteupEnable

- (BOOL) isQAVoteupEnable

Determines if the Q&A vote is allowed by the host or co-host.

Returns: If return YES if can vote. Otherwise, NO.

◆ reopenQuestionWithQuestionID:

- (ZoomSDKError) reopenQuestionWithQuestionID: (NSString *) questionID

Reopen the question.

Parameters

questionID The reopen question is.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setAttendeeViewQuestionType:

- (ZoomSDKError) setAttendeeViewQuestionType: (AttendeeViewQuestionType) type

Sets attendee view question type.

Parameters

type	The 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startLiving:

- (ZoomSDKError) startLiving: (NSString *) questionId

Starts answer question on living.

Parameters

questionId The ID of question.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ voteupQuestionWithQuestionID:isEableVokeup:

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

Vote the question.

Parameters

questionID	The vote question ID.
enable	If YES, vote the question, Otherwise cancel vote.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

◆ _delegate

- (id<ZoomSDKQAControllerDelegate>) _delegate

protected

Definition at line 295 of file ZoomSDKQAController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKQAControllerDelegate>) delegate

readwritenonatomicassign

Delegate to receive Q&A-related callback events.

Definition at line 300 of file ZoomSDKQAController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ addQuestionWithQuestionContent:isAnonymous:

◆ answerQuestionPrivateWithQuestionID:answerContent:

◆ answerQuestionPublicWithQuestionID:answerContent:

◆ commentQuestionWithQuestionID:commentContent:

◆ deleteAnswer:

◆ deleteQuestion:

◆ dismissQuestionWithQuestionID:

◆ enableAnonymousSendQuestion:

◆ enableAskQuestion:

◆ enableQAComment:

◆ enableQAVoteup:

◆ endLiving:

◆ getAllQuestionList

◆ getAnswerByAnswerID:

◆ getAnsweredQuestionCount

◆ getAnsweredQuestionList

◆ getDismissedQuestionCount

◆ getDismissedQuestionList

◆ getMyQuestionCount

◆ getMyQuestionList

◆ getOpenQuestionCount

◆ getOpenQuestionList

◆ getQALegalNoticesExplained

◆ getQALegalNoticesPrompt

◆ getQuestionByQuestionID:

◆ isAllowAskQuestionAnonymously

◆ isAskQuestionEnabled

◆ isAttendeeCanViewAllQuestions

◆ isQACommentEnabled

◆ isQAEnable

◆ isQALegalNoticeAvailable

◆ isQAVoteupEnable

◆ reopenQuestionWithQuestionID:

◆ setAttendeeViewQuestionType:

◆ startLiving:

◆ voteupQuestionWithQuestionID:isEableVokeup:

Field Documentation

◆ _delegate

Property Documentation

◆ delegate