Polling controller interface. More...

#include <meeting_polling_ctrl_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingPollingCtrlEvent *pEvent)=0
	Configure the meeting polling controller callback event handler.

virtual bool	CanDoPolling ()=0

virtual const zchar_t *	GetActivePollingID ()=0
	Get the active poll's ID.

virtual IList< IPollingQuestionItem * > *	GetPollingQuestionItemList (const zchar_t *pollingID)=0
	Get the list of poll's question.

virtual bool	CanGetRightAnswerItemList (const zchar_t *pollingID)=0
	Determine if the right answer item list can be allowed to get.

virtual IList< IPollingAnswerItem * > *	GetPollingRightAnswerItemList (const zchar_t *pollingID)=0
	Get the list of polling question or subquestion's right answer.

virtual bool	CanShowAnswerResultList (const zchar_t *pollingID)=0
	Determine if the answer result list can be show.

virtual IList< IPollingAnswerResultItem * > *	GetPollingAnswerResultItemList (const zchar_t *pollingID)=0
	Get the list of polling answer result item.

virtual IPollingItem *	GetPollingItemByID (const zchar_t *pollingID)=0
	Get the polling item object of specified polling ID.

virtual const zchar_t *	GetPollingQuestionImagePath (const zchar_t pollingID, const zchar_t questionID)=0
	Get the polling question's image path.

virtual SDKError	GetQuestionCharactersLengthRange (const zchar_t pollingID, const zchar_t questionID, unsigned int &minLen, unsigned int &maxLen)=0
	Get the polling question's minimum character and maximum character count.

virtual bool	IsQuestionCaseSensitive (const zchar_t pollingID, const zchar_t questionID)=0

virtual bool	CanAddPolling ()=0
	Determine if the host can add polling.

virtual SDKError	AddPolling ()=0
	Open create polling in a web browser.

virtual bool	CanEditPolling (const zchar_t *pollingID)=0
	Determine if the host can edit polling.

virtual SDKError	EditPolling (const zchar_t *pollingID)=0
	Open edit polling in a web browser.

virtual bool	CanDeletePolling (const zchar_t *pollingID)=0
	Determine if the host can delete polling.

virtual SDKError	DeletePolling (const zchar_t *pollingID)=0
	Delete the polling.

virtual bool	CanDuplicatePolling (const zchar_t *pollingID)=0
	Determine if the host can duplicate polling.

virtual SDKError	DuplicatePolling (const zchar_t *pollingID)=0
	Duplicate the polling.

virtual bool	CanViewPollingResultFromBrowser (const zchar_t *pollingID)=0
	Determine if the user can view polling results in the browser.

virtual SDKError	ViewPollingResultFromBrowser (const zchar_t *pollingID)=0
	Open a polling result in the web browser.

virtual IList< IPollingItem * > *	GetPollingItemList ()=0
	Get the list of poll item.

virtual bool	CanStartPolling (const zchar_t *pollingID)=0
	Determine if the host or co-host can start the polling.

virtual SDKError	StartPolling (const zchar_t *pollingID)=0
	Start the polling.

virtual SDKError	StopPolling (const zchar_t *pollingID)=0
	Stop the polling.

virtual bool	CanRestartPolling (const zchar_t *pollingID)=0
	Determine if the host or co-host can restart the polling.

virtual SDKError	RestartPolling (const zchar_t *pollingID)=0
	Restart the polling.

virtual bool	CanSharePollingResult (const zchar_t *pollingID)=0
	Determine if the host or co-host can share the poll's result.

virtual SDKError	StartSharePollingResult (const zchar_t *pollingID)=0
	Share the poll's result.

virtual SDKError	StopSharePollingResult (const zchar_t *pollingID)=0
	Stop the poll's result.

virtual SDKError	EnableGetRightAnswerList (bool bEnable)=0
	Set to enable show right answer to participants when share quiz's result.

virtual bool	CanDownloadResult ()=0
	Determine if the host can download poll's result from browser.

virtual SDKError	DownLoadResult ()=0
	Download all stopped poll's result from browser.

virtual SDKError	SetAnswerCheck (IPollingAnswerItem *answerItem, bool bCheck)=0
	Attendee set answer's check.

virtual SDKError	SetAnswerContent (IPollingAnswerItem answerItem, const zchar_t answerText)=0
	Attendee set answer's content.

virtual bool	CanSubmitPolling (const zchar_t *pollingID)=0
	Determine if the attendee can submit the polling.

virtual SDKError	SubmitPolling (const zchar_t *pollingID)=0
	Submit the polling.

Detailed Description

Polling controller interface.

Definition at line 161 of file meeting_polling_ctrl_interface.h.

Member Function Documentation

◆ AddPolling()

virtual SDKError IMeetingPollingController::AddPolling ( )

pure virtual

Open create polling in a web browser.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ CanAddPolling()

virtual bool IMeetingPollingController::CanAddPolling ( )

pure virtual

Determine if the host can add polling.

Remarks: Only the origin host can add polling.

◆ CanDeletePolling()

virtual bool IMeetingPollingController::CanDeletePolling ( const zchar_t * pollingID )

pure virtual

Determine if the host can delete polling.

Parameters

pollingID Specify the delete poll's polling ID.

Remarks: Only the origin host can delete polling.

◆ CanDoPolling()

virtual bool IMeetingPollingController::CanDoPolling ( )

pure virtual

Returns: True indicates you can do polling.

◆ CanDownloadResult()

virtual bool IMeetingPollingController::CanDownloadResult ( )

pure virtual

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

Remarks: Only the origin host can download.

◆ CanDuplicatePolling()

virtual bool IMeetingPollingController::CanDuplicatePolling ( const zchar_t * pollingID )

pure virtual

Determine if the host can duplicate polling.

Parameters

pollingID Specify the duplicate poll's polling ID.

Remarks: Only the origin host can duplicate polling.

◆ CanEditPolling()

virtual bool IMeetingPollingController::CanEditPolling ( const zchar_t * pollingID )

pure virtual

Determine if the host can edit polling.

Parameters

pollingID Specify the edit poll's polling ID.

Remarks: Only the origin host can edit polling.

◆ CanGetRightAnswerItemList()

virtual bool IMeetingPollingController::CanGetRightAnswerItemList ( const zchar_t * pollingID )

pure virtual

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

Parameters

pollingID Specify the right answer's polling ID.

◆ CanRestartPolling()

virtual bool IMeetingPollingController::CanRestartPolling ( const zchar_t * pollingID )

pure virtual

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

Parameters

pollingID Specify the poll's polling ID.

◆ CanSharePollingResult()

virtual bool IMeetingPollingController::CanSharePollingResult ( const zchar_t * pollingID )

pure virtual

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

Parameters

pollingID Specify the poll's polling ID.

◆ CanShowAnswerResultList()

virtual bool IMeetingPollingController::CanShowAnswerResultList ( const zchar_t * pollingID )

pure virtual

Determine if the answer result list can be show.

Parameters

pollingID Specify the answer result's polling ID.

◆ CanStartPolling()

virtual bool IMeetingPollingController::CanStartPolling ( const zchar_t * pollingID )

pure virtual

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

Parameters

pollingID Specify the poll's polling ID.

◆ CanSubmitPolling()

virtual bool IMeetingPollingController::CanSubmitPolling ( const zchar_t * pollingID )

pure virtual

Determine if the attendee can submit the polling.

Parameters

pollingID Specify the submit poll's polling ID.

◆ CanViewPollingResultFromBrowser()

virtual bool IMeetingPollingController::CanViewPollingResultFromBrowser ( const zchar_t * pollingID )

pure virtual

Determine if the user can view polling results in the browser.

Parameters

pollingID Specify the poll's polling ID.

Remarks: Only the origin host can view.

◆ DeletePolling()

virtual SDKError IMeetingPollingController::DeletePolling ( const zchar_t * pollingID )

pure virtual

Delete the polling.

Parameters

pollingID Specify the delete poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ DownLoadResult()

virtual SDKError IMeetingPollingController::DownLoadResult ( )

pure virtual

Download all stopped poll's result from browser.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ DuplicatePolling()

virtual SDKError IMeetingPollingController::DuplicatePolling ( const zchar_t * pollingID )

pure virtual

Duplicate the polling.

Parameters

pollingID Specify the duplicate poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ EditPolling()

virtual SDKError IMeetingPollingController::EditPolling ( const zchar_t * pollingID )

pure virtual

Open edit polling in a web browser.

Parameters

pollingID Specify the edit poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ EnableGetRightAnswerList()

virtual SDKError IMeetingPollingController::EnableGetRightAnswerList ( bool bEnable )

pure virtual

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

Parameters

bEnable TRUE indicates to enable. FALSE not.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ GetActivePollingID()

virtual const zchar_t * IMeetingPollingController::GetActivePollingID ( )

pure virtual

Get the active poll's ID.

Returns: The shared result or started poll's ID.

◆ GetPollingAnswerResultItemList()

virtual IList< IPollingAnswerResultItem * > * IMeetingPollingController::GetPollingAnswerResultItemList ( const zchar_t * pollingID )

pure virtual

Get the list of polling answer result item.

Parameters

pollingID Specify the answer result's polling ID.

Returns: If the function succeeds, the return value is a pointer to the IList<IPollingAnswerResultItem*>. Otherwise, the return value is nullptr.

◆ GetPollingItemByID()

virtual IPollingItem * IMeetingPollingController::GetPollingItemByID ( const zchar_t * pollingID )

pure virtual

Get the polling item object of specified polling ID.

Parameters

pollingID Specify the polling ID where you want to get the information.

Returns: If the function succeeds, the return value is a pointer to the IPollingItem, Otherwise the function fails, and the return value is nullptr.

◆ GetPollingItemList()

virtual IList< IPollingItem * > * IMeetingPollingController::GetPollingItemList ( )

pure virtual

Get the list of poll item.

Returns: If the function succeeds, the return value is a pointer to the IList<IPollingItem*>. Otherwise, the return value is nullptr.

◆ GetPollingQuestionImagePath()

virtual const zchar_t * IMeetingPollingController::GetPollingQuestionImagePath	(	const zchar_t *	pollingID,
		const zchar_t *	questionID )

pure virtual

Get the polling question's image path.

Parameters

pollingID	Specify the answer's polling ID.
questionID	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 nullptr.

◆ GetPollingQuestionItemList()

virtual IList< IPollingQuestionItem * > * IMeetingPollingController::GetPollingQuestionItemList ( const zchar_t * pollingID )

pure virtual

Get the list of poll's question.

Parameters

pollingID Specify the question's polling ID.

Returns: If the function succeeds, the return value is a pointer to the IList<IPollingQuestionItem*>. Otherwise, the return value is nullptr.

◆ GetPollingRightAnswerItemList()

virtual IList< IPollingAnswerItem * > * IMeetingPollingController::GetPollingRightAnswerItemList ( const zchar_t * pollingID )

pure virtual

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

Parameters

pollingID Specify the right answer's polling ID.

Returns: If the function succeeds, the return value is a pointer to the IList<IPollingAnswerItem*>, Otherwise, the return value is nullptr.

◆ GetQuestionCharactersLengthRange()

virtual SDKError IMeetingPollingController::GetQuestionCharactersLengthRange	(	const zchar_t *	pollingID,
		const zchar_t *	questionID,
		unsigned int &	minLen,
		unsigned int &	maxLen )

pure virtual

Get the polling question's minimum character and maximum character count.

Parameters

pollingID	Specify the question's polling ID.
pollingID	Specify the question's question ID.
minLen	Specify the minimum number of words to submit.
maxLen	Specify the maximum number of words to submit.

Remarks: This function can only be used by short answer question and long answer question.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ IsQuestionCaseSensitive()

virtual bool IMeetingPollingController::IsQuestionCaseSensitive	(	const zchar_t *	pollingID,
		const zchar_t *	questionID )

pure virtual

\Determine if the question is case sensitive.

Parameters

pollingID	Specify the question's polling ID.
questionID	Specify the question's question ID.

Remarks: This function can only be used by fill blank questions.

◆ RestartPolling()

virtual SDKError IMeetingPollingController::RestartPolling ( const zchar_t * pollingID )

pure virtual

Restart the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ SetAnswerCheck()

virtual SDKError IMeetingPollingController::SetAnswerCheck	(	IPollingAnswerItem *	answerItem,
		bool	bCheck )

pure virtual

Attendee set answer's check.

Parameters

answerItem	Specify the answer item to set. To get extended information, see IPollingAnswerItem enum.
bCheck	Specify you want to select the answer or not.

Remarks: This function should only be used by single, matching, rank order, multi, rating scale or drop down questions.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ SetAnswerContent()

virtual SDKError IMeetingPollingController::SetAnswerContent	(	IPollingAnswerItem *	answerItem,
		const zchar_t *	answerText )

pure virtual

Attendee set answer's content.

Parameters

answerItem	Specify the answer item to set. To get extended information, see IPollingAnswerItem enum.
answerText	Specify you want to reply answer's content.

Remarks: This function should only be used by fill blank, short answer or long answer questions.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError IMeetingPollingController::SetEvent ( IMeetingPollingCtrlEvent * pEvent )

pure virtual

Configure the meeting polling controller callback event handler.

Parameters

pEvent An object pointer to the IMeetingPollingCtrlEvent that receives the meeting polling callback event. For more details, see IMeetingPollingCtrlEvent.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

Remarks: The SDK use pEvent to transmit the callback event to the user's application. If the function is not called or fails, the user's application is unable to retrieve the callback event.

◆ StartPolling()

virtual SDKError IMeetingPollingController::StartPolling ( const zchar_t * pollingID )

pure virtual

Start the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ StartSharePollingResult()

virtual SDKError IMeetingPollingController::StartSharePollingResult ( const zchar_t * pollingID )

pure virtual

Share the poll's result.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ StopPolling()

virtual SDKError IMeetingPollingController::StopPolling ( const zchar_t * pollingID )

pure virtual

Stop the polling.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ StopSharePollingResult()

virtual SDKError IMeetingPollingController::StopSharePollingResult ( const zchar_t * pollingID )

pure virtual

Stop the poll's result.

Parameters

pollingID Specify the poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ SubmitPolling()

virtual SDKError IMeetingPollingController::SubmitPolling ( const zchar_t * pollingID )

pure virtual

Submit the polling.

Parameters

pollingID Specify the submit poll's polling ID.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ ViewPollingResultFromBrowser()

virtual SDKError IMeetingPollingController::ViewPollingResultFromBrowser ( const zchar_t * pollingID )

pure virtual

Open a polling result in the web browser.

Parameters

pollingID Specify the poll's polling ID.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddPolling()

◆ CanAddPolling()

◆ CanDeletePolling()

◆ CanDoPolling()

◆ CanDownloadResult()

◆ CanDuplicatePolling()

◆ CanEditPolling()

◆ CanGetRightAnswerItemList()

◆ CanRestartPolling()

◆ CanSharePollingResult()

◆ CanShowAnswerResultList()

◆ CanStartPolling()

◆ CanSubmitPolling()

◆ CanViewPollingResultFromBrowser()

◆ DeletePolling()

◆ DownLoadResult()

◆ DuplicatePolling()

◆ EditPolling()

◆ EnableGetRightAnswerList()

◆ GetActivePollingID()

◆ GetPollingAnswerResultItemList()

◆ GetPollingItemByID()

◆ GetPollingItemList()

◆ GetPollingQuestionImagePath()

◆ GetPollingQuestionItemList()

◆ GetPollingRightAnswerItemList()

◆ GetQuestionCharactersLengthRange()

◆ IsQuestionCaseSensitive()

◆ RestartPolling()

◆ SetAnswerCheck()

◆ SetAnswerContent()

◆ SetEvent()

◆ StartPolling()

◆ StartSharePollingResult()

◆ StopPolling()

◆ StopSharePollingResult()

◆ SubmitPolling()

◆ ViewPollingResultFromBrowser()