Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IMeetingPollingHelperSink Class Referenceabstract

Meeting Polling helper event callback. More...

#include <IMeetingPollingHelper.h>

Public Member Functions

virtual ~IMeetingPollingHelperSink ()
 
virtual void OnUpdatePollingBasicInfo (const PollingBasicInfo &basicInfo)=0
 Update polling basic info notification.
 
virtual void OnUpdateDetailPollingInfo (const PollingInfo &detailPolling)=0
 Polling detail info notification.
 
virtual void OnPollingStatusChange (const PollingInfo &polling, PollingRoleType roleType, const std::string &deviceID)=0
 Polling status change notification.
 
virtual void OnPollingDocReceived (const PollingInfo &detailPolling, const std::vector< PollingInfo > &pollings, bool isPollingButtonVisible)=0
 Receive polling doc notification.
 
virtual void OnPollingResultUpdated (const PollingInfo &polling)=0
 Polling result update notification.
 
virtual void OnPollingActionNotification (const PollingUserAction &userAction)=0
 Polling action notification.
 
virtual void OnTakeInChargeNotification (bool isSelfIncharge)=0
 Take in charge device update notification.
 
virtual void OnPollingDisplayOnZRNotification (bool enable)=0
 Polling display on ZR notification.
 
virtual void OnPollingIsShowPollOverlay (bool isShow)=0
 Indicates whether show overlay on ZR.
 
virtual void OnPollingRoleChanged (PollingRoleType roleType, bool isPollingButtonVisible)=0
 Polling role type changed notification.
 
virtual void OnPollingSessionInactiveNotification (bool isInactive)=0
 Polling session inactive notification.
 
virtual void OnPollingOptionsUpdated (const std::vector< PollingOption > &pollingOptions)=0
 Polling options update notification.
 
virtual void OnPollingAnswerUpdated (const PollingQuestionInfo &question)=0
 Polling question's answer update notification.
 
virtual void OnDownloadingFinished (const std::string &localFilePath, uint32_t result)=0
 Download result.
 

Detailed Description

Meeting Polling helper event callback.

Definition at line 211 of file IMeetingPollingHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingPollingHelperSink()

virtual IMeetingPollingHelperSink::~IMeetingPollingHelperSink ( )
inlinevirtual

Definition at line 214 of file IMeetingPollingHelper.h.

214{}

Member Function Documentation

◆ OnDownloadingFinished()

virtual void IMeetingPollingHelperSink::OnDownloadingFinished ( const std::string &  localFilePath,
uint32_t  result 
)
pure virtual

Download result.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
localFilePathThe specified local file path when calling download API.
result[0] success. Otherwise failed.

◆ OnPollingActionNotification()

virtual void IMeetingPollingHelperSink::OnPollingActionNotification ( const PollingUserAction userAction)
pure virtual

Polling action notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
userActionThe polling user action data.

◆ OnPollingAnswerUpdated()

virtual void IMeetingPollingHelperSink::OnPollingAnswerUpdated ( const PollingQuestionInfo question)
pure virtual

Polling question's answer update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
questionThe polling question info.

◆ OnPollingDisplayOnZRNotification()

virtual void IMeetingPollingHelperSink::OnPollingDisplayOnZRNotification ( bool  enable)
pure virtual

Polling display on ZR notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
enableTRUE indicates polling display on ZR screen.

◆ OnPollingDocReceived()

virtual void IMeetingPollingHelperSink::OnPollingDocReceived ( const PollingInfo detailPolling,
const std::vector< PollingInfo > &  pollings,
bool  isPollingButtonVisible 
)
pure virtual

Receive polling doc notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
detailPollingThe polling detail info.
pollingsAll the pollings basic info.
isPollingButtonVisibleTRUE indicates polling button is visible for host role.

◆ OnPollingIsShowPollOverlay()

virtual void IMeetingPollingHelperSink::OnPollingIsShowPollOverlay ( bool  isShow)
pure virtual

Indicates whether show overlay on ZR.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
isShowShow overlay status.

◆ OnPollingOptionsUpdated()

virtual void IMeetingPollingHelperSink::OnPollingOptionsUpdated ( const std::vector< PollingOption > &  pollingOptions)
pure virtual

Polling options update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
pollingOptionsThe polling options.

◆ OnPollingResultUpdated()

virtual void IMeetingPollingHelperSink::OnPollingResultUpdated ( const PollingInfo polling)
pure virtual

Polling result update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
pollingThe polling info.

◆ OnPollingRoleChanged()

virtual void IMeetingPollingHelperSink::OnPollingRoleChanged ( PollingRoleType  roleType,
bool  isPollingButtonVisible 
)
pure virtual

Polling role type changed notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
roleTypePolling role type, see PollingRoleType enum.
isPollingButtonVisibleTRUE indicates polling button is visible for host role.

◆ OnPollingSessionInactiveNotification()

virtual void IMeetingPollingHelperSink::OnPollingSessionInactiveNotification ( bool  isInactive)
pure virtual

Polling session inactive notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
isInactiveTRUE indicates polling session is inactive.

◆ OnPollingStatusChange()

virtual void IMeetingPollingHelperSink::OnPollingStatusChange ( const PollingInfo polling,
PollingRoleType  roleType,
const std::string &  deviceID 
)
pure virtual

Polling status change notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
pollingPolling info.
roleTypePolling role type.
deviceIDPolling incharge device ID.

◆ OnTakeInChargeNotification()

virtual void IMeetingPollingHelperSink::OnTakeInChargeNotification ( bool  isSelfIncharge)
pure virtual

Take in charge device update notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
isSelfInchargeTRUE indicates current is the incharge device of current polling.

◆ OnUpdateDetailPollingInfo()

virtual void IMeetingPollingHelperSink::OnUpdateDetailPollingInfo ( const PollingInfo detailPolling)
pure virtual

Polling detail info notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
detailPollingThe polling detail info.

◆ OnUpdatePollingBasicInfo()

virtual void IMeetingPollingHelperSink::OnUpdatePollingBasicInfo ( const PollingBasicInfo basicInfo)
pure virtual

Update polling basic info notification.

Since
6.1.0
Zoom Rooms minimum version
6.1.0
Parameters
basicInfoThe polling basic info.