Meeting Polling helper interface. More...

#include <IMeetingPollingHelper.h>

Public Member Functions
virtual	~IMeetingPollingHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingPollingHelperSink *pSink)=0
	Register meeting polling helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingPollingHelperSink *pSink)=0
	Deregister meeting polling helper callback sink.

virtual ZRCSDKError	GetPollingDetail (const std::string &pollingID)=0
	Get polling detail information.

virtual ZRCSDKError	OperatePolling (PollingActionType actionType, const std::string &pollingID)=0
	Operate polling.

virtual ZRCSDKError	SyncAnswer (const PollingQuestionInfo &question)=0
	Sync answer with ZR.

virtual ZRCSDKError	UpdatePollingOption (const PollingOption &option)=0
	Update polling option.

virtual ZRCSDKError	TakeInChargePolling ()=0
	Take in charge of polling.

virtual ZRCSDKError	IsSelfInChargePolling (bool &inCharge)=0
	Query if you are in charge of polling.

virtual ZRCSDKError	GetMyPollingRoleType (PollingRoleType &myRole)=0
	Query your polling role type.

virtual ZRCSDKError	UpdateDisplayOnZRInfo (const PollingDisplayOnZRInfo &option)=0
	Update display on ZR info.

virtual ZRCSDKError	EnableShowPollOverlay (bool enable, const std::string &pollingID, const std::string &questionID, int32_t questionIndex)=0
	Enable or disable show poll overlay.

virtual ZRCSDKError	ShowPollOverlay (bool show, const std::string &pollingID, const std::string &questionID, int32_t questionIndex)=0
	Show or hide poll overlay.

virtual ZRCSDKError	DownloadQuestionImage (const std::string &imageUrl, const std::string &localFilePath)=0
	Download question image.

Detailed Description

Meeting Polling helper interface.

Definition at line 365 of file IMeetingPollingHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingPollingHelper()

virtual IMeetingPollingHelper::~IMeetingPollingHelper ( )

inlinevirtual

Definition at line 368 of file IMeetingPollingHelper.h.

368{}

Member Function Documentation

◆ DeregisterSink()

virtual ZRCSDKError IMeetingPollingHelper::DeregisterSink ( IMeetingPollingHelperSink * pSink )

pure virtual

Deregister meeting polling helper callback sink.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pSink A pointer to the IMeetingPollingHelperSink that receives the meeting polling helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DownloadQuestionImage()

virtual ZRCSDKError IMeetingPollingHelper::DownloadQuestionImage	(	const std::string &	imageUrl,
		const std::string &	localFilePath
	)

pure virtual

Download question image.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

This will not auto create the folder if not exist.

Parameters

imageUrl	The image url.
localFilePath	Specify the local file path of this image. For example, ..../MyImageFolder/this_question.jpg

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EnableShowPollOverlay()

virtual ZRCSDKError IMeetingPollingHelper::EnableShowPollOverlay	(	bool	enable,
		const std::string &	pollingID,
		const std::string &	questionID,
		int32_t	questionIndex
	)

pure virtual

Enable or disable show poll overlay.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

This is only able to be used after polling started.

Parameters

enable	Enable or disable.
pollingID	Polling ID.
questionID	Question ID.
questionIndex	Question index.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetMyPollingRoleType()

virtual ZRCSDKError IMeetingPollingHelper::GetMyPollingRoleType ( PollingRoleType & myRole )

pure virtual

Query your polling role type.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] myRole The polling role type, see PollingRoleType enum.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetPollingDetail()

virtual ZRCSDKError IMeetingPollingHelper::GetPollingDetail ( const std::string & pollingID )

pure virtual

Get polling detail information.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pollingID Specific polling ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsSelfInChargePolling()

virtual ZRCSDKError IMeetingPollingHelper::IsSelfInChargePolling ( bool & inCharge )

pure virtual

Query if you are in charge of polling.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] inCharge TRUE indicates you are in charge of polling.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ OperatePolling()

virtual ZRCSDKError IMeetingPollingHelper::OperatePolling	(	PollingActionType	actionType,
		const std::string &	pollingID
	)

pure virtual

Operate polling.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

actionType	Specify action type, see PollingActionType enum.
pollingID	Specific polling ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingPollingHelper::RegisterSink ( IMeetingPollingHelperSink * pSink )

pure virtual

Register meeting polling helper callback sink.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pSink A pointer to the IMeetingPollingHelperSink that receives the meeting polling helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ShowPollOverlay()

virtual ZRCSDKError IMeetingPollingHelper::ShowPollOverlay	(	bool	show,
		const std::string &	pollingID,
		const std::string &	questionID,
		int32_t	questionIndex
	)

pure virtual

Show or hide poll overlay.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

This is only able to be used after polling started.

Parameters

show	Show or hide.
pollingID	Polling ID.
questionID	Question ID.
questionIndex	Question index.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SyncAnswer()

virtual ZRCSDKError IMeetingPollingHelper::SyncAnswer ( const PollingQuestionInfo & question )

pure virtual

Sync answer with ZR.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Check the [Required] fields in PollingQuestionInfo and PollingAnswer when sync answer with ZR.

Parameters

question The polling question info.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ TakeInChargePolling()

virtual ZRCSDKError IMeetingPollingHelper::TakeInChargePolling ( )

pure virtual

Take in charge of polling.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Only incharge device can answer questions.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpdateDisplayOnZRInfo()

virtual ZRCSDKError IMeetingPollingHelper::UpdateDisplayOnZRInfo ( const PollingDisplayOnZRInfo & option )

pure virtual

Update display on ZR info.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

This is only able to be used after polling started.

Parameters

option The display on ZR option.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpdatePollingOption()

virtual ZRCSDKError IMeetingPollingHelper::UpdatePollingOption ( const PollingOption & option )

pure virtual

Update polling option.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Polling options can only be configured before polling is started except PollingOptionTypeShowAnswerToAll.

Parameters

option The polling option.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingPollingHelper()

Member Function Documentation

◆ DeregisterSink()

◆ DownloadQuestionImage()

◆ EnableShowPollOverlay()

◆ GetMyPollingRoleType()

◆ GetPollingDetail()

◆ IsSelfInChargePolling()

◆ OperatePolling()

◆ RegisterSink()

◆ ShowPollOverlay()

◆ SyncAnswer()

◆ TakeInChargePolling()

◆ UpdateDisplayOnZRInfo()

◆ UpdatePollingOption()