Polling controller interface. More...

#include <ZoomSDKPollingController.h>

Inherits NSObject.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(ZoomSDKError)	- deletePolling:
	Deletes the polling.

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

(ZoomSDKError)	- duplicatePolling:
	Duplicate the polling.

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

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

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

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

(ZoomSDKError)	- startPolling:
	Starts the polling.

(ZoomSDKError)	- stopPolling:
	Stops the polling.

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

(ZoomSDKError)	- restartPolling:
	Restart the polling.

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

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

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

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

(BOOL)	- canDownloadResult
	Determines 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:
	Determines 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

Opens create polling in a web browser.

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

◆ canAddPolling

- (BOOL) canAddPolling

Determines if the host can add polling.

Returns: YES if allowed. Otherwise, NO.

Note: Only the origin host can add polling.

◆ canDeletePolling:

- (BOOL) canDeletePolling: (NSString *) pollingID

Determines if the host can delete polling.

Parameters

pollingID Specify the delete poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

Note: Only the origin host can delete polling.

◆ canDoPolling

- (BOOL) canDoPolling

Determines whether the current meeting can do the polling.

Returns: YES if can do polling. Otherwise, NO.

◆ canDownloadResult

- (BOOL) canDownloadResult

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

Returns: YES if allowed. Otherwise, NO.

Note: Only the origin host can download.

◆ canDuplicatePolling:

- (BOOL) canDuplicatePolling: (NSString *) pollingID

Determines if the host can duplicate polling.

Parameters

pollingID Specify the duplicate poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

Note: Only the origin host can duplicate polling.

◆ canEditPolling:

- (BOOL) canEditPolling: (NSString *) pollingID

Determines if the host can edit polling.

Parameters

pollingID Specify the edit poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

Note: Only the origin host can edit polling.

◆ canGetRightAnswerItemList:

- (BOOL) canGetRightAnswerItemList: (NSString *) pollingID

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

Parameters

pollingID Specify the right answer's polling ID.

Returns: YES if allowed. Otherwise, NO.

◆ canRestartPolling:

- (BOOL) canRestartPolling: (NSString *) pollingID

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

Parameters

pollingID Specify the poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

◆ canSharePollingResult:

- (BOOL) canSharePollingResult: (NSString *) pollingID

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

Parameters

pollingID Specify the poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

◆ canShowAnswerResultList:

- (BOOL) canShowAnswerResultList: (NSString *) pollingID

Determines if the answer result list can be show.

Parameters

pollingID Specify the answer result's polling ID.

Returns: YES if allowed. Otherwise, NO.

◆ canStartPolling:

- (BOOL) canStartPolling: (NSString *) pollingID

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

Parameters

pollingID Specify the poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

◆ canSubmitPolling:

- (BOOL) canSubmitPolling: (NSString *) pollingID

Determines if the attendee can submit the polling.

Parameters

pollingID Specify the submit poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

◆ canViewPollingResultFromBrowser:

- (BOOL) canViewPollingResultFromBrowser: (NSString *) pollingID

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

Parameters

pollingID Specify the poll's polling ID.

Returns: YES if allowed. Otherwise, NO.

Note: Only the origin host can view.

◆ deletePolling:

- (ZoomSDKError) deletePolling: (NSString *) pollingID

Deletes the polling.

Parameters

pollingID Specify the delete poll's polling ID.

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

◆ downLoadResult

- (ZoomSDKError) downLoadResult

Download all stopped poll's result from browser.

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

◆ duplicatePolling:

- (ZoomSDKError) duplicatePolling: (NSString *) pollingID

Duplicate the polling.

Parameters

pollingID Specify the duplicate poll's polling ID.

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

◆ editPolling:

- (ZoomSDKError) editPolling: (NSString *) pollingID

Opens edit polling in a web browser.

Parameters

pollingID Specify the edit poll's polling ID.

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

◆ enableGetRightAnswerList:

- (ZoomSDKError) enableGetRightAnswerList: (BOOL) bEnable

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

Parameters

bEnable YES to enable, NO otherwise.

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

◆ getActivePollingID

- (NSString *) getActivePollingID

Gets the active poll's ID.

Returns: If the function succeeds, it returns the shared result or started poll's ID. Otherwise, this function fails and returns nil.

◆ getPollingAnswerResultItemList:

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

Gets the list of polling answer result item.

Parameters

pollingID Specify the answer result's polling ID.

Returns: If the function succeeds, it returns an NSArray of ZoomSDKPollingAnswerResultItem objects. Otherwise, this function fails and returns nil.

◆ getPollingItemByID:

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

Gets 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, it returns a pointer to the ZoomSDKPollingItem. Otherwise, this function fails and returns nil.

◆ getPollingItemList

- (NSArray< ZoomSDKPollingItem * > *) getPollingItemList

Gets the list of poll item.

Returns: If the function succeeds, it returns a pointer to the NSArray<ZoomSDKPollingItem*>. Otherwise, this function fails and returns nil.

◆ getPollingQuestionImagePath:questionID:

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

Gets 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, it returns the question's image path. Otherwise, this function fails and returns nil.

◆ getPollingQuestionItemList:

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

Gets the list of poll's question.

Parameters

pollingID Specify the question's polling ID.

Returns: If the function succeeds, it returns an NSArray of ZoomSDKPollingQuestionItem objects. Otherwise, this function fails and returns nil.

◆ getPollingRightAnswerItemList:

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

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

Parameters

pollingID Specify the right answer's polling ID.

Returns: If the function succeeds, it returns an NSArray of ZoomSDKPollingAnswerItem objects. Otherwise, this function fails and returns nil.

◆ getQuestionCharactersLengthRange:questionID:minLen:maxLen:

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

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

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

◆ isQuestionCaseSensitive:questionID:

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

Determines if the question is case sensitive.

Parameters

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

Returns: YES if case sensitive. Otherwise, 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, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

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

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

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

◆ startPolling:

- (ZoomSDKError) startPolling: (NSString *) pollingID

Starts the polling.

Parameters

pollingID Specify the poll's polling ID.

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

◆ startSharePollingResult:

- (ZoomSDKError) startSharePollingResult: (NSString *) pollingID

Share the poll's result.

Parameters

pollingID Specify the poll's polling ID.

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

◆ stopPolling:

- (ZoomSDKError) stopPolling: (NSString *) pollingID

Stops the polling.

Parameters

pollingID Specify the poll's polling ID.

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

◆ stopSharePollingResult:

- (ZoomSDKError) stopSharePollingResult: (NSString *) pollingID

Stops to share the poll's result.

Parameters

pollingID Specify the poll's polling ID.

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

◆ submitPolling:

- (ZoomSDKError) submitPolling: (NSString *) pollingID

Submit the polling.

Parameters

pollingID Specify the submit poll's polling ID.

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

◆ viewPollingResultFromBrowser:

- (ZoomSDKError) viewPollingResultFromBrowser: (NSString *) pollingID

Opens a polling result in the web browser.

Parameters

pollingID Specify the poll's polling ID.

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

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