Meeting SDK for Windows API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IMeetingPollingCtrlEvent Class Referenceabstract

Polling controller callback event. More...

#include <meeting_polling_ctrl_interface.h>

Public Member Functions

virtual ~IMeetingPollingCtrlEvent ()
 
virtual void onPollingStatusChanged (const zchar_t *pollingID, SDKPollingStatus status)=0
 Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.
 
virtual void onPollingResultUpdated (const zchar_t *pollingID)=0
 Polling result updated callback. This is triggered when a participant submits polling.
 
virtual void onPollingListUpdated ()=0
 
virtual void onPollingActionResult (SDKPollingActionType actionType, const zchar_t *pollingID, bool bSuccess, const zchar_t *errorMsg)=0
 Polling action result callback. This is triggered when a user perform an action for a poll.
 
virtual void onPollingQuestionImageDownloaded (const zchar_t *questionID, const zchar_t *path)=0
 Polling question item image downloaded callback. \This is triggered when a user starts or joins a meeting, if any polling question has image, or host uploads an image to a polling question in the meeting.
 
virtual void onPollingElapsedTime (const zchar_t *pollingID, unsigned int uElapsedtime)=0
 Polling elapsed time callback. \This is triggered when a host starts a poll or a user changes to host from non host.
 
virtual void onGetRightAnswerListPrivilege (bool bCan)=0
 Callback event for the user get right answer list privilege changed. This is triggered when the host calls EnableGetRightAnswerList in a quiz.
 
virtual void onPollingInactive ()=0
 polling inactive callback. When the user starts a meeting in another device by same account, this callback is triggered. Then call CanDoPolling return false.
 

Detailed Description

Polling controller callback event.

Definition at line 124 of file meeting_polling_ctrl_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingPollingCtrlEvent()

virtual IMeetingPollingCtrlEvent::~IMeetingPollingCtrlEvent ( )
inlinevirtual

Definition at line 127 of file meeting_polling_ctrl_interface.h.

127{}

Member Function Documentation

◆ onGetRightAnswerListPrivilege()

virtual void IMeetingPollingCtrlEvent::onGetRightAnswerListPrivilege ( bool bCan)
pure virtual

Callback event for the user get right answer list privilege changed. This is triggered when the host calls EnableGetRightAnswerList in a quiz.

Parameters
bCanSpecify whether the user has get right answer list privilege or not.

◆ onPollingActionResult()

virtual void IMeetingPollingCtrlEvent::onPollingActionResult ( SDKPollingActionType actionType,
const zchar_t * pollingID,
bool bSuccess,
const zchar_t * errorMsg )
pure virtual

Polling action result callback. This is triggered when a user perform an action for a poll.

Parameters
actionTypeSpecify the action type. For more details, see SDKPollingActionType enum.
pollingIDSpecify the action poll's ID.
bSuccessSpecify whether the action succeeds.
errorMsgSpecify the error message when the action fails. It is only for SDKPollingActionType_Error.
Remarks
If actionType is SDKPollingActionType_Error, use errorMsg. This errorMsg may be triggered by any action.

◆ onPollingElapsedTime()

virtual void IMeetingPollingCtrlEvent::onPollingElapsedTime ( const zchar_t * pollingID,
unsigned int uElapsedtime )
pure virtual

Polling elapsed time callback. \This is triggered when a host starts a poll or a user changes to host from non host.

Parameters
uElapsedtimeSpecify the polling elapsed time in milliseconds.

◆ onPollingInactive()

virtual void IMeetingPollingCtrlEvent::onPollingInactive ( )
pure virtual

polling inactive callback. When the user starts a meeting in another device by same account, this callback is triggered. Then call CanDoPolling return false.

◆ onPollingListUpdated()

virtual void IMeetingPollingCtrlEvent::onPollingListUpdated ( )
pure virtual

◆ onPollingQuestionImageDownloaded()

virtual void IMeetingPollingCtrlEvent::onPollingQuestionImageDownloaded ( const zchar_t * questionID,
const zchar_t * path )
pure virtual

Polling question item image downloaded callback. \This is triggered when a user starts or joins a meeting, if any polling question has image, or host uploads an image to a polling question in the meeting.

Parameters
questionIDSpecify the polling question's ID.
pathSpecify the image downloaded path.

◆ onPollingResultUpdated()

virtual void IMeetingPollingCtrlEvent::onPollingResultUpdated ( const zchar_t * pollingID)
pure virtual

Polling result updated callback. This is triggered when a participant submits polling.

Parameters
pollingIDSpecify the result updated poll's ID.

◆ onPollingStatusChanged()

virtual void IMeetingPollingCtrlEvent::onPollingStatusChanged ( const zchar_t * pollingID,
SDKPollingStatus status )
pure virtual

Polling status changed callback. Use this function to inform the user that the polling has been started, share result or stopped.

Parameters
pollingIDSpecify the status changed poll's ID.
statusSpecify current polling status. For more details, see SDKPollingStatus enum.