Zoom Meeting Polling
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
onPollingStatusChanged |
function
|
Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped. |
onPollingResultUpdated |
function
|
Polling result updated callback. This is triggered when a participant submits polling. |
onPollingListUpdated |
function
|
Polling list updated callback. This is triggered when a host adds, edits, duplicates or deletes a polling. |
onPollingActionResult |
function
|
Polling action result callback. This is triggered when a user perform an action for a poll. |
Returns:
-
Type
-
ZoomMeetingPolling
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
onPollingStatusChanged |
function
|
Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped. |
onPollingResultUpdated |
function
|
Polling result updated callback. This is triggered when a participant submits polling. |
onPollingListUpdated |
function
|
Polling list updated callback. This is triggered when a host adds, edits, duplicates or deletes a polling. |
onPollingActionResult |
function
|
Polling action result callback. This is triggered when a user perform an action for a poll. |
Returns:
-
Type
-
ZoomMeetingPolling
Methods
(inner) CanDoPolling() → {Boolean}
- Description:
- Determine whether the current meeting can do the polling.
- Source:
Returns:
True indicates you can do polling
-
Type
-
Boolean
(inner) CanDoPolling() → {Boolean}
- Description:
- Determine whether the current meeting can do the polling.
- Source:
Returns:
True indicates you can do polling
-
Type
-
Boolean
(inner) CanGetRightAnswerItemList(pollingID) → {Number}
- Description:
- Determine if the right answer item list can be allowed to get.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the right answer's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) CanGetRightAnswerItemList(pollingID) → {Number}
- Description:
- Determine if the right answer item list can be allowed to get.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the right answer's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) GetPollingAnswerResultItemList(pollingID) → {Array}
- Description:
- Get the list of polling answer result item.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the answer result's polling ID |
Returns:
If the function succeeds, the return value is a list of polling answer result item objects, each with the following properties:
- pollingID
- pollingQuestionID
- pollingSubQuestionID
- pollingAnswerID
- pollingAnswerName
- selectedCount: How many participants selected this answer.
-
Type
-
Array
(inner) GetPollingAnswerResultItemList(pollingID) → {Array}
- Description:
- Get the list of polling answer result item.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the answer result's polling ID |
Returns:
If the function succeeds, the return value is a list of polling answer result item objects, each with the following properties:
- pollingID
- pollingQuestionID
- pollingSubQuestionID
- pollingAnswerID
- pollingAnswerName
- selectedCount: How many participants selected this answer.
-
Type
-
Array
(inner) GetPollingItemByID(pollingID) → {Object}
- Description:
- Get the polling item object of specified polling ID.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the polling ID where you want to get the information |
Returns:
If the function succeeds, the return value is a polling item object with the following properties:
- pollingID
- pollingName
- pollingType
- pollingStatus
- pollingQuestionCount
- totalVotedUserCount
- isLibraryPolling
-
Type
-
Object
(inner) GetPollingItemByID(pollingID) → {Object}
- Description:
- Get the polling item object of specified polling ID.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the polling ID where you want to get the information |
Returns:
If the function succeeds, the return value is a polling item object with the following properties:
- pollingID
- pollingName
- pollingType
- pollingStatus
- pollingQuestionCount
- totalVotedUserCount
- isLibraryPolling
-
Type
-
Object
(inner) GetPollingItemList() → {Array}
- Description:
- Get the list of poll item.
- Source:
Returns:
If the function succeeds, the return value is a list of polling item objects, each with the following properties:
- pollingID
- pollingName
- pollingType
- pollingStatus
- pollingQuestionCount
- totalVotedUserCount
- isLibraryPolling
-
Type
-
Array
(inner) GetPollingItemList() → {Array}
- Description:
- Get the list of poll item.
- Source:
Returns:
If the function succeeds, the return value is a list of polling item objects, each with the following properties:
- pollingID
- pollingName
- pollingType
- pollingStatus
- pollingQuestionCount
- totalVotedUserCount
- isLibraryPolling
-
Type
-
Array
(inner) GetPollingQuestionImagePath(pollingID, questionID) → {String}
- Description:
- Get the polling question's image path.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the answer's polling ID |
questionID |
String
|
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 null.
-
Type
-
String
(inner) GetPollingQuestionImagePath(pollingID, questionID) → {String}
- Description:
- Get the polling question's image path.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the answer's polling ID |
questionID |
String
|
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 null.
-
Type
-
String
(inner) GetPollingQuestionItemList(pollingID) → {Array}
- Description:
- Get the list of poll's question.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the question's polling ID |
Returns:
If the function succeeds, the return value is a list of polling question item objects, each with the following properties:
- pollingID
- pollingQuestionID
- pollingQuestionName
- pollingQuestionType
- answeredCount
- isRequired
-
Type
-
Array
(inner) GetPollingQuestionItemList(pollingID) → {Array}
- Description:
- Get the list of poll's question.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the question's polling ID |
Returns:
If the function succeeds, the return value is a list of polling question item objects, each with the following properties:
- pollingID
- pollingQuestionID
- pollingQuestionName
- pollingQuestionType
- answeredCount
- isRequired
-
Type
-
Array
(inner) GetPollingRightAnswerItemList(pollingID) → {Array}
- Description:
- Get the list of polling question or subquestion's right answer.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the right answer's polling ID |
Returns:
If the function succeeds, the return value is a list of polling answer item objects, each with the following properties:
- pollingID
- pollingQuestionID
- pollingSubQuestionID
- pollingAnswerID
- pollingAnswerName
- pollingAnsweredContent
- isChecked: This property has no meaning for the correct answer.
-
Type
-
Array
(inner) GetPollingRightAnswerItemList(pollingID) → {Array}
- Description:
- Get the list of polling question or subquestion's right answer.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the right answer's polling ID |
Returns:
If the function succeeds, the return value is a list of polling answer item objects, each with the following properties:
- pollingID
- pollingQuestionID
- pollingSubQuestionID
- pollingAnswerID
- pollingAnswerName
- pollingAnsweredContent
- isChecked: This property has no meaning for the correct answer.
-
Type
-
Array
(inner) IsQuestionCaseSensitive(pollingID, questionID) → {Boolean}
- Description:
- Determine if the question is case sensitive.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the question's polling ID |
questionID |
String
|
Specify the question's question ID |
Returns:
True indicates the question is case sensitive, otherwise false
-
Type
-
Boolean
(inner) IsQuestionCaseSensitive(pollingID, questionID) → {Boolean}
- Description:
- Determine if the question is case sensitive.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the question's polling ID |
questionID |
String
|
Specify the question's question ID |
Returns:
True indicates the question is case sensitive, otherwise false
-
Type
-
Boolean
(inner) RestartPolling(pollingID) → {Number}
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the poll's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) RestartPolling(pollingID) → {Number}
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the poll's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) SetOnPollingActionResultCB(onPollingActionResult) → {Boolean}
- Description:
- Set onPollingActionResult callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingActionResult |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingActionResultCB(onPollingActionResult) → {Boolean}
- Description:
- Set onPollingActionResult callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingActionResult |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingListUpdatedCB(onPollingListUpdated) → {Boolean}
- Description:
- Set onPollingListUpdated callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingListUpdated |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingListUpdatedCB(onPollingListUpdated) → {Boolean}
- Description:
- Set onPollingListUpdated callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingListUpdated |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingResultUpdatedCB(onPollingResultUpdated) → {Boolean}
- Description:
- Set onPollingResultUpdated callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingResultUpdated |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingResultUpdatedCB(onPollingResultUpdated) → {Boolean}
- Description:
- Set onPollingResultUpdated callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingResultUpdated |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingStatusChangedCB(onPollingStatusChanged) → {Boolean}
- Description:
- Set onPollingStatusChanged callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingStatusChanged |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnPollingStatusChangedCB(onPollingStatusChanged) → {Boolean}
- Description:
- Set onPollingStatusChanged callback.
- Source:
Parameters:
| Name |
Type |
Description |
onPollingStatusChanged |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) StartPolling(pollingID) → {Number}
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the poll's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) StartPolling(pollingID) → {Number}
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the poll's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) StopPolling(pollingID) → {Number}
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the poll's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) StopPolling(pollingID) → {Number}
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the poll's polling ID |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
Events
onPollingActionResult
- Description:
- Polling action result callback. This is triggered when a user perform an action for a poll.
- Source:
Parameters:
| Name |
Type |
Description |
actionType |
Number
|
Specify the action type. |
pollingID |
String
|
Specify the action poll's ID. |
bSuccess |
Boolean
|
Specify whether the action succeeds. |
errorMsg |
String
|
Specify the error message when the action fails. It is only for SDKPollingActionType_Error. |
onPollingActionResult
- Description:
- Polling action result callback. This is triggered when a user perform an action for a poll.
- Source:
Parameters:
| Name |
Type |
Description |
actionType |
Number
|
Specify the action type. |
pollingID |
String
|
Specify the action poll's ID. |
bSuccess |
Boolean
|
Specify whether the action succeeds. |
errorMsg |
String
|
Specify the error message when the action fails. It is only for SDKPollingActionType_Error. |
onPollingListUpdated
- Description:
- Polling list updated callback. This is triggered when a host adds, edits, duplicates or deletes a polling.
- Source:
onPollingListUpdated
- Description:
- Polling list updated callback. This is triggered when a host adds, edits, duplicates or deletes a polling.
- Source:
onPollingResultUpdated
- Description:
- Polling result updated callback. This is triggered when a participant submits polling.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the result updated poll's ID. |
onPollingResultUpdated
- Description:
- Polling result updated callback. This is triggered when a participant submits polling.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the result updated poll's ID. |
onPollingStatusChanged
- Description:
- Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the status changed poll's ID. |
status |
Number
|
Specify current polling status. |
onPollingStatusChanged
- Description:
- Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.
- Source:
Parameters:
| Name |
Type |
Description |
pollingID |
String
|
Specify the status changed poll's ID. |
status |
Number
|
Specify current polling status. |