Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
us.zoom.sdk.InMeetingPollingController Interface Reference

Polling controller interface. More...

Public Member Functions

MobileRTCSDKError setEvent (IMeetingPollingCtrlEvent pEvent)
 Configure the meeting polling controller callback event handler.
 
boolean canDoPolling ()
 Determine whether the current meeting can do the polling.
 
boolean canShowAnswerResultList (String pollingID)
 Determine if the answer result list can be show.
 
List< IPollingQuestionItemgetPollingQuestionItemList (String pollingID)
 Get the list of poll's question.
 
List< IPollingAnswerItemgetPollingRightAnswerItemList (String pollingID)
 Get the list of polling question or subquestion's right answer.
 
List< IPollingAnswerResultItemgetPollingAnswerResultItemList (String pollingID)
 Get the list of polling answer result item.
 
IPollingItem getPollingItemByID (String pollingID)
 Get the polling item object of specified polling ID.
 
boolean canGetRightAnswerItemList (String pollingID)
 Determine if the right answer item list can be allowed to get.
 
String getPollingQuestionImagePath (String pollingID, String pollingQuestionID)
 Get the polling question's image path.
 
SDKQuestionCharactersLength getQuestionCharactersLengthRange (String pollingID, String pollingQuestionID)
 Get the polling question's minimum character and maximum character count. This function can only be used by short answer question and long answer question.
 
boolean isQuestionCaseSensitive (String pollingID, String pollingQuestionID)
 Determine if the question is case sensitive.
 
boolean canAddPolling ()
 Determine if the host can add polling. Only the origin host can add polling.
 
MobileRTCSDKError addPolling ()
 Open create polling in a web browser.
 
boolean canEditPolling (String pollingID)
 Determine if the host can edit polling. Only the origin host can edit polling.
 
MobileRTCSDKError editPolling (String pollingID)
 Open edit polling in a web browser.
 
boolean canDeletePolling (String pollingID)
 Determine if the host can delete polling. Only the origin host can delete polling.
 
MobileRTCSDKError deletePolling (String pollingID)
 Delete the polling.
 
boolean canDuplicatePolling (String pollingID)
 Determine if the host can duplicate polling. Only the origin host can duplicate polling.
 
MobileRTCSDKError duplicatePolling (String pollingID)
 Duplicate the polling.
 
boolean canViewPollingResultFromBrowser (String pollingID)
 Determine if the user can view polling result from browser..
 
MobileRTCSDKError viewPollingResultFromBrowser (String pollingID)
 Open a polling result in the web browser.
 
List< IPollingItemgetPollingItemList ()
 Get the list of poll item.
 
boolean canStartPolling (String pollingID)
 Determine if the host or co-host can start the polling.
 
MobileRTCSDKError startPolling (String pollingID)
 Start the polling.
 
MobileRTCSDKError stopPolling (String pollingID)
 Stop the polling.
 
boolean canRestartPolling (String pollingID)
 Determine if the host or co-host can restart the polling.
 
MobileRTCSDKError restartPolling (String pollingID)
 Restart the polling.
 
boolean canSharePollingResult (String pollingID)
 Determine if the host or co-host can share the poll's result.
 
MobileRTCSDKError startSharePollingResult (String pollingID)
 Share the poll's result.
 
MobileRTCSDKError stopSharePollingResult (String pollingID)
 Stop the poll's result.
 
MobileRTCSDKError enableGetRightAnswerList (boolean bEnable)
 Set to enable show right answer to participants when share quiz's result.
 
String getActivePollingID ()
 Get the active poll's ID.
 
boolean canDownloadResult ()
 Determine if the host can download poll's result from browser. Only the origin host can download.
 
MobileRTCSDKError downLoadResult ()
 Download all stopped poll's result from browser.
 
MobileRTCSDKError setAnswerCheck (IPollingAnswerItem answerItem, boolean bCheck)
 Attendee set answer's check. This function should only be used by single, matching, rank order, multi, rating scale or drop down questions.
 
MobileRTCSDKError setAnswerContent (IPollingAnswerItem answerItem, String answerText)
 Attendee set answer's content. This function should only be used by fill blank, short answer and long answer questions.
 
boolean canSubmitPolling (String pollingID)
 Determine if the attendee can submit the polling.
 
MobileRTCSDKError submitPolling (String pollingID)
 Submit the polling.
 

Detailed Description

Polling controller interface.

Definition at line 8 of file InMeetingPollingController.java.

Member Function Documentation

◆ addPolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.addPolling ( )

Open create polling in a web browser.

Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ canAddPolling()

boolean us.zoom.sdk.InMeetingPollingController.canAddPolling ( )

Determine if the host can add polling. Only the origin host can add polling.

Returns
true indicates you can do.Just origin host can add.

◆ canDeletePolling()

boolean us.zoom.sdk.InMeetingPollingController.canDeletePolling ( String pollingID)

Determine if the host can delete polling. Only the origin host can delete polling.

Parameters
pollingIDSpecify the delete poll's polling ID.
Returns
true indicates you can do.Just origin host can edit.

◆ canDoPolling()

boolean us.zoom.sdk.InMeetingPollingController.canDoPolling ( )

Determine whether the current meeting can do the polling.

Returns
true indicates you can do polling.

◆ canDownloadResult()

boolean us.zoom.sdk.InMeetingPollingController.canDownloadResult ( )

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

Returns
true indicates you can download the result.

◆ canDuplicatePolling()

boolean us.zoom.sdk.InMeetingPollingController.canDuplicatePolling ( String pollingID)

Determine if the host can duplicate polling. Only the origin host can duplicate polling.

Parameters
pollingIDSpecify the duplicate poll's polling ID.
Returns
true indicates you can do.

◆ canEditPolling()

boolean us.zoom.sdk.InMeetingPollingController.canEditPolling ( String pollingID)

Determine if the host can edit polling. Only the origin host can edit polling.

Parameters
pollingIDSpecify the edit poll's polling ID.
Returns
true indicates you can do.Just origin host can edit.

◆ canGetRightAnswerItemList()

boolean us.zoom.sdk.InMeetingPollingController.canGetRightAnswerItemList ( String pollingID)

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

Parameters
pollingIDSpecify the right answer's polling ID.
Returns
true indicates you can do.

◆ canRestartPolling()

boolean us.zoom.sdk.InMeetingPollingController.canRestartPolling ( String pollingID)

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

Parameters
pollingIDSpecify the poll's polling ID.
Returns
true indicates you can do.

◆ canSharePollingResult()

boolean us.zoom.sdk.InMeetingPollingController.canSharePollingResult ( String pollingID)

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

Parameters
pollingIDSpecify the poll's polling ID.
Returns
true indicates you can do.

◆ canShowAnswerResultList()

boolean us.zoom.sdk.InMeetingPollingController.canShowAnswerResultList ( String pollingID)

Determine if the answer result list can be show.

Parameters
pollingIDSpecify the answer result's polling ID.
Returns
true indicates you can do.

◆ canStartPolling()

boolean us.zoom.sdk.InMeetingPollingController.canStartPolling ( String pollingID)

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

Parameters
pollingIDSpecify the poll's polling ID.
Returns
true indicates you can do.

◆ canSubmitPolling()

boolean us.zoom.sdk.InMeetingPollingController.canSubmitPolling ( String pollingID)

Determine if the attendee can submit the polling.

Parameters
pollingIDSpecify the submit poll's polling ID.
Returns
true indicates you can do.

◆ canViewPollingResultFromBrowser()

boolean us.zoom.sdk.InMeetingPollingController.canViewPollingResultFromBrowser ( String pollingID)

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

Parameters
pollingIDSpecify the poll's polling ID.、 remarks Just origin host can duplicate.
Returns
true indicates you can do.

◆ deletePolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.deletePolling ( String pollingID)

Delete the polling.

Parameters
pollingIDSpecify the delete poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ downLoadResult()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.downLoadResult ( )

Download all stopped poll's result from browser.

Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ duplicatePolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.duplicatePolling ( String pollingID)

Duplicate the polling.

Parameters
pollingIDSpecify the duplicate poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ editPolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.editPolling ( String pollingID)

Open edit polling in a web browser.

Parameters
pollingIDSpecify the edit poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ enableGetRightAnswerList()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.enableGetRightAnswerList ( boolean bEnable)

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

Parameters
bEnabletrue indicates to enable. FALSE not.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ getActivePollingID()

String us.zoom.sdk.InMeetingPollingController.getActivePollingID ( )

Get the active poll's ID.

Returns
The shared result or started poll's ID.

◆ getPollingAnswerResultItemList()

List< IPollingAnswerResultItem > us.zoom.sdk.InMeetingPollingController.getPollingAnswerResultItemList ( String pollingID)

Get the list of polling answer result item.

Parameters
pollingIDSpecify the answer result's polling ID.
Returns
If the function succeeds the return value is List. Otherwise, the return value is null or empty .

◆ getPollingItemByID()

IPollingItem us.zoom.sdk.InMeetingPollingController.getPollingItemByID ( String pollingID)

Get the polling item object of specified polling ID.

Parameters
pollingIDSpecify the polling ID for which you want to get the information.
Returns
If the function succeeds the return value is List. Otherwise the function fails and the return value is null .

◆ getPollingItemList()

List< IPollingItem > us.zoom.sdk.InMeetingPollingController.getPollingItemList ( )

Get the list of poll item.

Returns
If the function succeeds the return value is List. Otherwise, the return value is null or empty .

◆ getPollingQuestionImagePath()

String us.zoom.sdk.InMeetingPollingController.getPollingQuestionImagePath ( String pollingID,
String pollingQuestionID )

Get the polling question's image path.

Parameters
pollingIDSpecify the answer's polling ID.
pollingQuestionIDSpecify 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 null.

◆ getPollingQuestionItemList()

List< IPollingQuestionItem > us.zoom.sdk.InMeetingPollingController.getPollingQuestionItemList ( String pollingID)

Get the list of poll's question.

Parameters
pollingIDSpecify the question's polling ID.
Returns
If the function succeeds the return value is List. Otherwise, the return value is null or empty .

◆ getPollingRightAnswerItemList()

List< IPollingAnswerItem > us.zoom.sdk.InMeetingPollingController.getPollingRightAnswerItemList ( String pollingID)

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

Parameters
pollingIDSpecify the right answer's polling ID.
Returns
If the function succeeds the return value is List. Otherwise, the return value is null or empty .

◆ getQuestionCharactersLengthRange()

SDKQuestionCharactersLength us.zoom.sdk.InMeetingPollingController.getQuestionCharactersLengthRange ( String pollingID,
String pollingQuestionID )

Get the polling question's minimum character and maximum character count. This function can only be used by short answer question and long answer question.

Parameters
pollingIDSpecify the question's polling ID.
pollingQuestionIDSpecify the question's question ID.

◆ isQuestionCaseSensitive()

boolean us.zoom.sdk.InMeetingPollingController.isQuestionCaseSensitive ( String pollingID,
String pollingQuestionID )

Determine if the question is case sensitive.

Parameters
pollingIDSpecify the question's polling ID.
pollingQuestionIDSpecify the question's question ID.
Returns
Specify the question's question ID.

◆ restartPolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.restartPolling ( String pollingID)

Restart the polling.

Parameters
pollingIDSpecify the poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ setAnswerCheck()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.setAnswerCheck ( IPollingAnswerItem answerItem,
boolean bCheck )

Attendee set answer's check. This function should only be used by single, matching, rank order, multi, rating scale or drop down questions.

Parameters
answerItemIPollingAnswerItem
bCheckSpecify whether you want to select the answer or not.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ setAnswerContent()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.setAnswerContent ( IPollingAnswerItem answerItem,
String answerText )

Attendee set answer's content. This function should only be used by fill blank, short answer and long answer questions.

Parameters
answerItemIPollingAnswerItem
answerTextSpecify you want to reply answer's content.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ setEvent()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.setEvent ( IMeetingPollingCtrlEvent pEvent)

Configure the meeting polling controller callback event handler.

Parameters
pEventEvent object.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ startPolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.startPolling ( String pollingID)

Start the polling.

Parameters
pollingIDSpecify the poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ startSharePollingResult()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.startSharePollingResult ( String pollingID)

Share the poll's result.

Parameters
pollingIDSpecify the poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ stopPolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.stopPolling ( String pollingID)

Stop the polling.

Parameters
pollingIDSpecify the poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ stopSharePollingResult()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.stopSharePollingResult ( String pollingID)

Stop the poll's result.

Parameters
pollingIDSpecify the poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ submitPolling()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.submitPolling ( String pollingID)

Submit the polling.

Parameters
pollingIDSpecify the submit poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ viewPollingResultFromBrowser()

MobileRTCSDKError us.zoom.sdk.InMeetingPollingController.viewPollingResultFromBrowser ( String pollingID)

Open a polling result in the web browser.

Parameters
pollingIDSpecify the poll's polling ID.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.