Polling controller interface. More...

#include <ZoomSDKPollingController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- canDoPolling
	Determine whether the current meeting can do the polling.

(BOOL)	- canShowAnswerResultList:
	Determine if the answer result list can be show.

(NSArray< ZoomSDKPollingQuestionItem * > *)	- getPollingQuestionItemList:
	Get the list of poll's question.

(NSArray< ZoomSDKPollingAnswerItem * > *)	- getPollingRightAnswerItemList:
	Get the list of polling question or subquestion's right answer.

(NSArray< ZoomSDKPollingAnswerResultItem * > *)	- getPollingAnswerResultItemList:
	Get the list of polling answer result item.

(ZoomSDKPollingItem *)	- getPollingItemByID:
	Get the polling item object of specified polling ID.

(BOOL)	- canGetRightAnswerItemList:
	Determine if the right answer item list can be allowed to get.

(NSString *)	- getPollingQuestionImagePath:questionID:
	Get the polling question's image path.

(ZoomSDKError)	- getQuestionCharactersLengthRange:questionID:minLen:maxLen:
	Get the polling question's minimum character and maximum character count.

(BOOL)	- isQuestionCaseSensitive:questionID:
	Determine if the question is case sensitive.

(NSString *)	- getActivePollingID
	Get the active poll's ID.

(BOOL)	- canAddPolling
	Determine if the host can add polling.

(ZoomSDKError)	- addPolling
	Open create polling in a web browser.

(BOOL)	- canEditPolling:
	Determine if the host can edit polling.

(ZoomSDKError)	- editPolling:
	Open edit polling in a web browser.

(BOOL)	- canDeletePolling:
	Determine if the host can delete polling.

(ZoomSDKError)	- deletePolling:
	Delete the polling.

(BOOL)	- canDuplicatePolling:
	Determine if the host can duplicate polling.

(ZoomSDKError)	- duplicatePolling:
	Duplicate the polling.

(BOOL)	- canViewPollingResultFromBrowser:
	Determine if the user can view polling result in the browser.

(ZoomSDKError)	- viewPollingResultFromBrowser:
	Open a polling result in the web browser.

(NSArray< ZoomSDKPollingItem * > *)	- getPollingItemList
	Get the list of poll item.

(BOOL)	- canStartPolling:
	Determine if the host or co-host can start the polling.

(ZoomSDKError)	- startPolling:
	Start the polling.

(ZoomSDKError)	- stopPolling:
	Stop the polling.

(BOOL)	- canRestartPolling:
	Determine if the host or co-host can restart the polling.

(ZoomSDKError)	- restartPolling:
	Restart the polling.

(BOOL)	- canSharePollingResult:
	Determine if the host or co-host can share the poll's result.

(ZoomSDKError)	- startSharePollingResult:
	Share the poll's result.

(ZoomSDKError)	- stopSharePollingResult:
	Stop to share the poll's result.

(ZoomSDKError)	- enableGetRightAnswerList:
	Set to enable show right answer to participants when share quiz's result.

(BOOL)	- canDownloadResult
	Determine if the host can download poll's result from browser.

(ZoomSDKError)	- downLoadResult
	Download all stopped poll's result from browser.

(ZoomSDKError)	- setAnswerCheck:bCheck:
	Attendee set answer's check.

(ZoomSDKError)	- setAnswerContent:answerText:
	Attendee set answer's content.

(BOOL)	- canSubmitPolling:
	Determine if the attendee can submit the polling.

(ZoomSDKError)	- submitPolling:
	Submit the polling.

Protected Attributes
id< ZoomSDKPollingControllerDelegate >	_delegate

Properties
id< ZoomSDKPollingControllerDelegate >	delegate
	Delegate object to receive polling events.

Detailed Description

Polling controller interface.

Definition at line 313 of file ZoomSDKPollingController.h.

Method Documentation

◆ addPolling

- (ZoomSDKError) addPolling

Open create polling in a web browser.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function fails.

◆ canAddPolling

- (BOOL) canAddPolling

Determine if the host can add polling.

Returns: YES means can. Otherwise, the return value is NO.

Note: Only the origin host can add polling.

◆ canDeletePolling:

- (BOOL) canDeletePolling: (NSString *) pollingID

Determine if the host can delete polling.

Parameters

pollingID Specify the delete poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

Note: Only the origin host can delete polling.

◆ canDoPolling

- (BOOL) canDoPolling

Determine whether the current meeting can do the polling.

Returns: YES indicates you can do polling.

◆ canDownloadResult

- (BOOL) canDownloadResult

Determine if the host can download poll's result from browser.

Returns: YES means can. Otherwise, the return value is NO.

Note: Only the origin host can download.

◆ canDuplicatePolling:

- (BOOL) canDuplicatePolling: (NSString *) pollingID

Determine if the host can duplicate polling.

Parameters

pollingID Specify the duplicate poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

Note: Only the origin host can duplicate polling.

◆ canEditPolling:

- (BOOL) canEditPolling: (NSString *) pollingID

Determine if the host can edit polling.

Parameters

pollingID Specify the edit poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

Note: Only the origin host can edit polling.

◆ canGetRightAnswerItemList:

- (BOOL) canGetRightAnswerItemList: (NSString *) pollingID

Determine if the right answer item list can be allowed to get.

Parameters

pollingID Specify the right answer's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

◆ canRestartPolling:

- (BOOL) canRestartPolling: (NSString *) pollingID

Determine if the host or co-host can restart the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

◆ canSharePollingResult:

- (BOOL) canSharePollingResult: (NSString *) pollingID

Determine if the host or co-host can share the poll's result.

Parameters

pollingID Specify the poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

◆ canShowAnswerResultList:

- (BOOL) canShowAnswerResultList: (NSString *) pollingID

Determine if the answer result list can be show.

Parameters

pollingID Specify the answer result's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

◆ canStartPolling:

- (BOOL) canStartPolling: (NSString *) pollingID

Determine if the host or co-host can start the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

◆ canSubmitPolling:

- (BOOL) canSubmitPolling: (NSString *) pollingID

Determine if the attendee can submit the polling.

Parameters

pollingID Specify the submit poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

◆ canViewPollingResultFromBrowser:

- (BOOL) canViewPollingResultFromBrowser: (NSString *) pollingID

Determine if the user can view polling result in the browser.

Parameters

pollingID Specify the poll's polling ID.

Returns: YES means can. Otherwise, the return value is NO.

Note: Only the origin host can view.

◆ deletePolling:

- (ZoomSDKError) deletePolling: (NSString *) pollingID

Delete the polling.

Parameters

pollingID Specify the delete poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function fails.

◆ downLoadResult

- (ZoomSDKError) downLoadResult

Download all stopped poll's result from browser.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ duplicatePolling:

- (ZoomSDKError) duplicatePolling: (NSString *) pollingID

Duplicate the polling.

Parameters

pollingID Specify the duplicate poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function fails.

◆ editPolling:

- (ZoomSDKError) editPolling: (NSString *) pollingID

Open edit polling in a web browser.

Parameters

pollingID Specify the edit poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function fails.

◆ enableGetRightAnswerList:

- (ZoomSDKError) enableGetRightAnswerList: (BOOL) bEnable

Set to enable show right answer to participants when share quiz's result.

Parameters

bEnable YES indicates to enable. NO means not.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ getActivePollingID

- (NSString *) getActivePollingID

Get the active poll's ID.

Returns: The shared result or started poll's ID.

◆ getPollingAnswerResultItemList:

- (NSArray< ZoomSDKPollingAnswerResultItem * > *) getPollingAnswerResultItemList: (NSString *) pollingID

Get the list of polling answer result item.

Parameters

pollingID Specify the answer result's polling ID.

Returns: If the function succeeds, the return value is an NSArray of ZoomSDKPollingAnswerResultItem objects. Otherwise, the return value is nil.

◆ getPollingItemByID:

- (ZoomSDKPollingItem *) getPollingItemByID: (NSString *) pollingID

Get the polling item object of specified polling ID.

Parameters

pollingID Specify the polling ID for which you want to get the information.

Returns: If the function succeeds, the return value is a pointer to the ZoomSDKPollingItem. Otherwise, the return value is nil.

◆ getPollingItemList

- (NSArray< ZoomSDKPollingItem * > *) getPollingItemList

Get the list of poll item.

Returns: If the function succeeds, the return value is a pointer to the NSArray<ZoomSDKPollingItem*>. Otherwise, the return value is nil.

◆ getPollingQuestionImagePath:questionID:

- (NSString *) getPollingQuestionImagePath:		(NSString *)	pollingID
questionID:		(NSString *)	questionID

Get the polling question's image path.

Parameters

pollingID	Specify the answer's polling ID.
questionID	Specify the answer's question ID.

Returns: If the function succeeds, the return value is the question's image path, Otherwise the function fails, and the return value is nil.

◆ getPollingQuestionItemList:

- (NSArray< ZoomSDKPollingQuestionItem * > *) getPollingQuestionItemList: (NSString *) pollingID

Get the list of poll's question.

Parameters

pollingID Specify the question's polling ID.

Returns: If the function succeeds, the return value is an NSArray of ZoomSDKPollingQuestionItem objects. Otherwise, the return value is nil.

◆ getPollingRightAnswerItemList:

- (NSArray< ZoomSDKPollingAnswerItem * > *) getPollingRightAnswerItemList: (NSString *) pollingID

Get the list of polling question or subquestion's right answer.

Parameters

pollingID Specify the right answer's polling ID.

Returns: If the function succeeds, the return value is an NSArray of ZoomSDKPollingAnswerItem objects. Otherwise, the return value is nil.

◆ getQuestionCharactersLengthRange:questionID:minLen:maxLen:

- (ZoomSDKError) getQuestionCharactersLengthRange:	(NSString *)	pollingID
questionID:	(NSString *)	questionID
minLen:	(unsigned int *)	minLen
maxLen:	(unsigned int *)	maxLen

Get the polling question's minimum character and maximum character count.

Parameters

pollingID	Specify the question's polling ID.
questionID	Specify the question's question ID.
minLen	Specify the minimum number of words to submit.
maxLen	Specify the maximum number of words to submit.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

Note: This function can only be used by short answer question and long answer question.

◆ isQuestionCaseSensitive:questionID:

- (BOOL) isQuestionCaseSensitive:		(NSString *)	pollingID
questionID:		(NSString *)	questionID

Determine if the question is case sensitive.

Parameters

pollingID	Specify the question's polling ID.
questionID	Specify the question's question ID.

Returns: YES means is case sensitive. Otherwise, the return value is NO.

Note: This function can only be used by fill blank questions.

◆ restartPolling:

- (ZoomSDKError) restartPolling: (NSString *) pollingID

Restart the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ setAnswerCheck:bCheck:

- (ZoomSDKError) setAnswerCheck:		(ZoomSDKPollingAnswerItem *)	answerItem
bCheck:		(BOOL)	bCheck

Attendee set answer's check.

Parameters

answerItem	Specify the object of ZoomSDKPollingAnswerItem.
bCheck	Specify whether you want to select the answer or not.

Remarks: This function should only be used by single, matching, rank order, multi, rating scale, or drop down questions.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ setAnswerContent:answerText:

- (ZoomSDKError) setAnswerContent:		(ZoomSDKPollingAnswerItem *)	answerItem
answerText:		(NSString *)	answerText

Attendee set answer's content.

Parameters

answerItem	Specify the object of ZoomSDKPollingAnswerItem.
answerText	Specify you want to reply answer's content.

Returns: If the function succeeds, the return value ZoomSDKError_Success. Otherwise, the function fails.

Note: This function should only be used by fill blank, short answer and long answer questions.

◆ startPolling:

- (ZoomSDKError) startPolling: (NSString *) pollingID

Start the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ startSharePollingResult:

- (ZoomSDKError) startSharePollingResult: (NSString *) pollingID

Share the poll's result.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ stopPolling:

- (ZoomSDKError) stopPolling: (NSString *) pollingID

Stop the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ stopSharePollingResult:

- (ZoomSDKError) stopSharePollingResult: (NSString *) pollingID

Stop to share the poll's result.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ submitPolling:

- (ZoomSDKError) submitPolling: (NSString *) pollingID

Submit the polling.

Parameters

pollingID Specify the submit poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise, the function fails.

◆ viewPollingResultFromBrowser:

- (ZoomSDKError) viewPollingResultFromBrowser: (NSString *) pollingID

Open a polling result in the web browser.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function fails.

Field Documentation

◆ _delegate

- (id<ZoomSDKPollingControllerDelegate>) _delegate

protected

Definition at line 315 of file ZoomSDKPollingController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKPollingControllerDelegate>) delegate

readwritenonatomicassign

Delegate object to receive polling events.

Definition at line 320 of file ZoomSDKPollingController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ addPolling

◆ canAddPolling

◆ canDeletePolling:

◆ canDoPolling

◆ canDownloadResult

◆ canDuplicatePolling:

◆ canEditPolling:

◆ canGetRightAnswerItemList:

◆ canRestartPolling:

◆ canSharePollingResult:

◆ canShowAnswerResultList:

◆ canStartPolling:

◆ canSubmitPolling:

◆ canViewPollingResultFromBrowser:

◆ deletePolling:

◆ downLoadResult

◆ duplicatePolling:

◆ editPolling:

◆ enableGetRightAnswerList:

◆ getActivePollingID

◆ getPollingAnswerResultItemList:

◆ getPollingItemByID:

◆ getPollingItemList

◆ getPollingQuestionImagePath:questionID:

◆ getPollingQuestionItemList:

◆ getPollingRightAnswerItemList:

◆ getQuestionCharactersLengthRange:questionID:minLen:maxLen:

◆ isQuestionCaseSensitive:questionID:

◆ restartPolling:

◆ setAnswerCheck:bCheck:

◆ setAnswerContent:answerText:

◆ startPolling:

◆ startSharePollingResult:

◆ stopPolling:

◆ stopSharePollingResult:

◆ submitPolling:

◆ viewPollingResultFromBrowser:

Field Documentation

◆ _delegate

Property Documentation

◆ delegate