meeting_polling_ctrl_interface.h

Go to the documentation of this file.

 
#ifndef _MEETING_POLLING_CTRL_INTERFACE_H_
#define _MEETING_POLLING_CTRL_INTERFACE_H_
#include "zoom_sdk_def.h"
 
BEGIN_ZOOM_SDK_NAMESPACE
 
typedef enum
{
    SDKPollingStatus_Initial,     
    SDKPollingStatus_Started,     
    SDKPollingStatus_ShareResult, 
    SDKPollingStatus_Stopped,     
}SDKPollingStatus;
 
typedef enum
{
    SDKPollingType_Unknown,
    SDKPollingType_Poll,
    SDKPollingType_Quiz
}SDKPollingType;
 
typedef enum
{
    SDKPollingQuestionType_Unknown,
    SDKPollingQuestionType_Single,
    SDKPollingQuestionType_Multi,
    SDKPollingQuestionType_Matching,
    SDKPollingQuestionType_RankOrder,
    SDKPollingQuestionType_ShortAnswer,
    SDKPollingQuestionType_LongAnswer,
    SDKPollingQuestionType_FillBlank,
    SDKPollingQuestionType_RatingScale,
    SDKPollingQuestionType_Dropdown,
}SDKPollingQuestionType;
 
 
typedef enum
{
    SDKPollingActionType_Unknown,
    SDKPollingActionType_Start,
    SDKPollingActionType_Stop,
    SDKPollingActionType_ShareResult,
    SDKPollingActionType_StopShareResult,
    SDKPollingActionType_Duplicate,
    SDKPollingActionType_Delete,
    SDKPollingActionType_Submit,
    SDKPollingActionType_Error
}SDKPollingActionType;
 
class IPollingItem
{
public:
    virtual ~IPollingItem() {}
    virtual const zchar_t* GetPollingID() = 0;
    virtual const zchar_t* GetPollingName() = 0;
    virtual SDKPollingType GetPollingType() = 0;
    virtual SDKPollingStatus GetPollingStatus() = 0;
    virtual unsigned int GetPollingQuestionCount() = 0;
    virtual unsigned int GetTotalVotedUserCount() = 0;
    virtual bool IsLibraryPolling() = 0;
};
 
class IPollingAnswerItem
{
public:
    virtual ~IPollingAnswerItem() {}
    virtual const zchar_t* GetPollingID() = 0;
    virtual const zchar_t* GetPollingQuestionID() = 0;
    virtual const zchar_t* GetPollingSubQuestionID() = 0;
    virtual const zchar_t* GetPollingAnswerID() = 0;
    virtual const zchar_t* GetPollingAnswerName() = 0;
    virtual const zchar_t* GetPollingAnsweredContent() = 0;
    virtual bool IsChecked() = 0; //This property has no meaning for the correct answer.
};
 
class IPollingQuestionItem
{
public:
    virtual ~IPollingQuestionItem() {}
    virtual const zchar_t* GetPollingID() = 0;
    virtual const zchar_t* GetPollingQuestionID() = 0;
    virtual const zchar_t* GetPollingQuestionName() = 0;
    virtual SDKPollingQuestionType GetPollingQuestionType() = 0;
    virtual unsigned int GetAnsweredCount() = 0;
    virtual bool IsRequired() = 0;
    virtual IList<IPollingQuestionItem*>* GetPollingSubQuestionItemList() = 0; //Only matching, fill blank or rank order question has subquestion
    virtual IList<IPollingAnswerItem*>* GetPollingAnswerItemList() = 0;
};
 
class IPollingAnswerResultItem
{
public:
    virtual ~IPollingAnswerResultItem() {}
    virtual const zchar_t* GetPollingID() = 0;
    virtual const zchar_t* GetPollingQuestionID() = 0;
    virtual const zchar_t* GetPollingSubQuestionID() = 0;
    virtual const zchar_t* GetPollingAnswerID() = 0;
    virtual const zchar_t* GetPollingAnswerName() = 0;
    virtual unsigned int GetSelectedCount() = 0;  //How many participants selected this answer.
};
 
class IMeetingPollingCtrlEvent
{
public:
    virtual ~IMeetingPollingCtrlEvent() {}
    virtual void onPollingStatusChanged(const zchar_t* pollingID, SDKPollingStatus status) = 0;
    virtual void onPollingResultUpdated(const zchar_t* pollingID) = 0;
    // \brief Polling list updated callback. This is triggered when a host adds, edits, duplicates or deletes a polling.
    virtual void onPollingListUpdated() = 0;
    virtual void onPollingActionResult(SDKPollingActionType actionType, const zchar_t* pollingID, bool bSuccess, const zchar_t* errorMsg) = 0;
    virtual void onPollingQuestionImageDownloaded(const zchar_t* questionID, const zchar_t* path) = 0;
    virtual void onPollingElapsedTime(const zchar_t* pollingID, unsigned int uElapsedtime) = 0;
    virtual void onGetRightAnswerListPrivilege(bool bCan) = 0;
    virtual void onPollingInactive() = 0;
};
 
class IMeetingPollingController
{
public:
    virtual SDKError SetEvent(IMeetingPollingCtrlEvent* pEvent) = 0;
 
    //Common (for all)
    
    // \brief Determine whether the current meeting can do the polling.
    virtual bool CanDoPolling() = 0;
    virtual const zchar_t* GetActivePollingID() = 0;
    virtual IList<IPollingQuestionItem*>* GetPollingQuestionItemList(const zchar_t* pollingID) = 0;
    virtual bool CanGetRightAnswerItemList(const zchar_t* pollingID) = 0;
    virtual IList<IPollingAnswerItem*>* GetPollingRightAnswerItemList(const zchar_t* pollingID) = 0;
    virtual bool CanShowAnswerResultList(const zchar_t* pollingID) = 0;
    virtual IList<IPollingAnswerResultItem*>* GetPollingAnswerResultItemList(const zchar_t* pollingID) = 0;
    virtual IPollingItem* GetPollingItemByID(const zchar_t* pollingID) = 0;
    virtual const zchar_t* GetPollingQuestionImagePath(const zchar_t* pollingID, const zchar_t* questionID) = 0;
    virtual SDKError GetQuestionCharactersLengthRange(const zchar_t* pollingID, const zchar_t* questionID, unsigned int& minLen, unsigned int& maxLen) = 0;
    virtual bool IsQuestionCaseSensitive(const zchar_t* pollingID, const zchar_t* questionID) = 0;
 
    //Host 
 
    virtual bool CanAddPolling() = 0;
    virtual SDKError AddPolling() = 0;
    virtual bool CanEditPolling(const zchar_t* pollingID) = 0;
    virtual SDKError EditPolling(const zchar_t* pollingID) = 0;
    virtual bool CanDeletePolling(const zchar_t* pollingID) = 0;
    virtual SDKError DeletePolling(const zchar_t* pollingID) = 0;
    virtual bool CanDuplicatePolling(const zchar_t* pollingID) = 0;
    virtual SDKError DuplicatePolling(const zchar_t* pollingID) = 0;
    virtual bool CanViewPollingResultFromBrowser(const zchar_t* pollingID) = 0;
    virtual SDKError ViewPollingResultFromBrowser(const zchar_t* pollingID) = 0;
    virtual IList<IPollingItem*>* GetPollingItemList() = 0;
    virtual bool CanStartPolling(const zchar_t* pollingID) = 0;
    virtual SDKError StartPolling(const zchar_t* pollingID) = 0;
    virtual SDKError StopPolling(const zchar_t* pollingID) = 0;
    virtual bool CanRestartPolling(const zchar_t* pollingID) = 0;
    virtual SDKError RestartPolling(const zchar_t* pollingID) = 0;
    virtual bool CanSharePollingResult(const zchar_t* pollingID) = 0;
    virtual SDKError StartSharePollingResult(const zchar_t* pollingID) = 0;
    virtual SDKError StopSharePollingResult(const zchar_t* pollingID) = 0;
    virtual SDKError EnableGetRightAnswerList(bool bEnable) = 0;
    virtual bool CanDownloadResult() = 0;
    virtual SDKError DownLoadResult() = 0;
 
    //Attendee
 
    virtual SDKError SetAnswerCheck(IPollingAnswerItem* answerItem, bool bCheck) = 0;
    virtual SDKError SetAnswerContent(IPollingAnswerItem* answerItem, const zchar_t* answerText) = 0;
    virtual bool CanSubmitPolling(const zchar_t* pollingID) = 0;
    virtual SDKError SubmitPolling(const zchar_t* pollingID) = 0;
};
 
END_ZOOM_SDK_NAMESPACE
#endif