meeting_ai_companion_interface.h

Go to the documentation of this file.

#ifndef _MEETING_AI_COMPANION_INTERFACE_H_
#define _MEETING_AI_COMPANION_INTERFACE_H_
#include "zoom_sdk_def.h"
 
BEGIN_ZOOM_SDK_NAMESPACE

enum AICompanionFeature
{
    SMART_SUMMARY,    
    QUERY,            
    SMART_RECORDING,  
};

enum MeetingAICompanionQueryFeedbackType
{
    MeetingAICompanionQueryFeedbackType_None = 0,   
    MeetingAICompanionQueryFeedbackType_Good,       
    MeetingAICompanionQueryFeedbackType_Bad
};

enum MeetingAICompanionQueryRequestError
{
    MeetingAICompanionQueryRequestError_OK = 0,                 
    MeetingAICompanionQueryRequestError_InvalidParam,           
    MeetingAICompanionQueryRequestError_SendFailed,             
    MeetingAICompanionQueryRequestError_WebUnAvailable,         
    MeetingAICompanionQueryRequestError_PermissionVerifyFailed,
    MeetingAICompanionQueryRequestError_QueryRateLimitError,    
    MeetingAICompanionQueryRequestError_Timeout,                
    MeetingAICompanionQueryRequestError_Unknown = 100           
};

enum MeetingAICompanionQuerySettingOptions
{
    MeetingAICompanionQuerySettingOptions_None = 0,             
    MeetingAICompanionQuerySettingOptions_WhenQueryStarted,     
    MeetingAICompanionQuerySettingOptions_WhenParticipantsJoin, 
    MeetingAICompanionQuerySettingOptions_OnlyHost,             
    MeetingAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization, 
    MeetingAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin,        
    MeetingAICompanionQuerySettingOptions_HostAndPanelists = 10,  
    MeetingAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization    
};

class IMeetingEnableSmartSummaryHandler
{
public:
    virtual ~IMeetingEnableSmartSummaryHandler() {};

    virtual SDKError EnableSmartSummary() = 0;

    virtual bool IsForRequest() = 0;
};

class IMeetingStartSmartSummaryHandler
{
public:
    virtual ~IMeetingStartSmartSummaryHandler() {};

    virtual SDKError StartSmartSummary() = 0;

    virtual bool IsForRequest() = 0;
};

class IMeetingStopSmartSummaryHandler
{
public:
    virtual ~IMeetingStopSmartSummaryHandler() {};

    virtual SDKError StopSmartSummary() = 0;
};

class IMeetingEnableSmartSummaryActionHandler
{
public:
    virtual ~IMeetingEnableSmartSummaryActionHandler() {};

    virtual const zchar_t* GetTipTitle() = 0;

    virtual const zchar_t* GetTipString() = 0;

    virtual SDKError Confirm() = 0;

    virtual SDKError Cancel() = 0;
};

class IMeetingApproveStartSmartSummaryHandler
{
public:
    virtual ~IMeetingApproveStartSmartSummaryHandler() {};

    virtual unsigned int GetSenderUserID() = 0;

    virtual const zchar_t* GetRequestUserName() = 0;

    virtual SDKError Approve() = 0;

    virtual SDKError Decline() = 0;
};

class IMeetingApproveEnableSmartSummaryHandler
{
public:
    virtual ~IMeetingApproveEnableSmartSummaryHandler() {};

    virtual unsigned int GetSenderUserID() = 0;

    virtual SDKError ContinueApprove() = 0;
};

class IMeetingAICompanionSmartSummaryHelperEvent
{
public:
    virtual void onSmartSummaryStateNotSupported() = 0;

    virtual void onSmartSummaryStateSupportedButDisabled(IMeetingEnableSmartSummaryHandler* handler) = 0;

    virtual void onSmartSummaryStateEnabledButNotStarted(IMeetingStartSmartSummaryHandler* handler) = 0;

    virtual void onSmartSummaryStateStarted(IMeetingStopSmartSummaryHandler* handler) = 0;

    virtual void onFailedToStartSmartSummary(bool bTimeout) = 0;

    virtual void onSmartSummaryEnableRequestReceived(IMeetingApproveEnableSmartSummaryHandler* handler) = 0;

    virtual void onSmartSummaryStartRequestReceived(IMeetingApproveStartSmartSummaryHandler* handler) = 0;

    virtual void onSmartSummaryEnableActionCallback(IMeetingEnableSmartSummaryActionHandler* handler) = 0;
 
    virtual ~IMeetingAICompanionSmartSummaryHelperEvent() {}
 
};

class IMeetingAICompanionSmartSummaryHelper
{
public:
    virtual ~IMeetingAICompanionSmartSummaryHelper() {}

    virtual void SetEvent(IMeetingAICompanionSmartSummaryHelperEvent* event) = 0;
};
 

class ISmartSummaryPrivilegeHandler
{
public:
    virtual ~ISmartSummaryPrivilegeHandler() {};

    virtual SDKError Accept() = 0;

    virtual SDKError Decline() = 0;

    virtual SDKError Ignore() = 0;
};

class IMeetingSmartSummaryHelperEvent
{
public:
    virtual void onSmartSummaryStatusChange(bool isStarted) = 0;

    virtual void onSmartSummaryPrivilegeRequested(unsigned int senderId, ISmartSummaryPrivilegeHandler* handler) = 0;

    virtual void onSmartSummaryStartReqResponse(bool timeout, bool decline) = 0;

    virtual void onEnableSmartSummary() = 0;
 
    virtual ~IMeetingSmartSummaryHelperEvent() {}
 
};

class IMeetingSmartSummaryHelper
{
public:
    virtual ~IMeetingSmartSummaryHelper() {}
    virtual void SetEvent(IMeetingSmartSummaryHelperEvent* event) = 0;

    virtual bool IsSmartSummarySupported() = 0;

    virtual bool IsSmartSummaryEnabled() = 0;

    virtual SDKError CanEnableSmartSummaryFeature() = 0;

    virtual SDKError EnableSmartSummaryFeature() = 0;

    virtual SDKError CanStartSmartSummary() = 0;

    virtual SDKError StartSmartSummary() = 0;

    virtual SDKError StopSmartSummary() = 0;

    virtual bool IsSmartSummaryStarted() = 0;

    virtual SDKError CanRequestEnableSmartSummaryFeature() = 0;

    virtual SDKError RequestEnableSmartSummaryFeature() = 0;

    virtual SDKError CanRequestStartSmartSummary() = 0;

    virtual SDKError RequestStartSmartSummary() = 0;
};

class IMeetingAICompanionQueryItem
{
public:
    virtual ~IMeetingAICompanionQueryItem() {}

    virtual const zchar_t* GetQueryID() = 0;

    virtual const zchar_t* GetQustionContent() = 0;

    virtual const zchar_t* GetAnswerContent() = 0;

    virtual MeetingAICompanionQueryRequestError GetErrorCode() = 0;

    virtual const zchar_t* GetErrorMsg() = 0;

    virtual time_t GetTimeStamp() = 0;

    virtual SDKError Feedback(MeetingAICompanionQueryFeedbackType eFeedbackType) = 0;
};

class IMeetingEnableQueryHandler
{
public:
    virtual ~IMeetingEnableQueryHandler() {}

    virtual SDKError EnableQuery() = 0;

    virtual bool IsForRequest() = 0;
};

class IMeetingStartQueryHandler
{
public:
    virtual ~IMeetingStartQueryHandler() {}

    virtual SDKError StartMeetingQuery() = 0;

    virtual bool IsForRequest() = 0;
};

class IMeetingApproveEnableQueryHandler
{
public:
    virtual ~IMeetingApproveEnableQueryHandler() {}

    virtual unsigned int GetSenderUserID() = 0;

    virtual SDKError ContinueApprove() = 0;
};

class IMeetingApproveStartQueryHandler
{
public:
    virtual ~IMeetingApproveStartQueryHandler() {}

    virtual unsigned int GetSenderUserID() = 0;

    virtual const zchar_t* GetRequestUserName() = 0;

    virtual SDKError Approve() = 0;

    virtual SDKError Decline() = 0;
};

class IMeetingSendQueryHandler
{
public:
    virtual ~IMeetingSendQueryHandler() {}

    virtual IList<const zchar_t*>* GetDefaultQueryQuestions() = 0;

    virtual SDKError SendQueryQuestion(const zchar_t* sQuestion) = 0;

    virtual SDKError StopMeetingQuery() = 0;

    virtual bool CanSendQuery() = 0;

    virtual SDKError RequestSendQueryPrivilege() = 0;
};

class IMeetingEnableQueryActionHandler
{
public:
    virtual ~IMeetingEnableQueryActionHandler() {}

    virtual const zchar_t* GetTipTitle() = 0;

    virtual const zchar_t* GetTipString() = 0;

    virtual SDKError Confirm() = 0;

    virtual SDKError Cancel() = 0;
};

class IMeetingApproveSendQueryHandler
{
public:
    virtual ~IMeetingApproveSendQueryHandler() {}

    virtual unsigned int GetSenderUserID() = 0;

    virtual const zchar_t* GetRequestUserName() = 0;

    virtual SDKError Approve() = 0;

    virtual SDKError Decline(bool bDeclineAll) = 0;
};
 

class IMeetingAICompanionQueryHelperEvent
{
public:
    virtual ~IMeetingAICompanionQueryHelperEvent() {}

    virtual void onQueryStateNotSupported() = 0;

    virtual void onQueryStateSupportedButDisabled(IMeetingEnableQueryHandler* pHandler) = 0;

    virtual void onQueryStateEnabledButNotStarted(IMeetingStartQueryHandler* pHandler) = 0;

    virtual void onQueryStateStarted(IMeetingSendQueryHandler* pHandler) = 0;

    virtual void onQuerySettingChanged(MeetingAICompanionQuerySettingOptions eSetting) = 0;

    virtual void onFailedToStartQuery(bool bTimeout) = 0;

    virtual void onReceiveRequestToEnableQuery(IMeetingApproveEnableQueryHandler* pHandler) = 0;

    virtual void onReceiveRequestToStartQuery(IMeetingApproveStartQueryHandler* pHandler) = 0;

    virtual void onReceiveQueryAnswer(IMeetingAICompanionQueryItem* pQueryItem) = 0;

    virtual void onQueryEnableActionCallback(IMeetingEnableQueryActionHandler* pHandler) = 0;

    virtual void onSendQueryPrivilegeChanged(bool canSendQuery) = 0;

    virtual void onFailedToRequestSendQuery(bool bTimeout) = 0;

    virtual void onReceiveRequestToSendQuery(IMeetingApproveSendQueryHandler* pHandler) = 0;
};
 

class IMeetingAICompanionQueryHelper
{
public:
    virtual ~IMeetingAICompanionQueryHelper() {}
    virtual void SetEvent(IMeetingAICompanionQueryHelperEvent* event) = 0;

    virtual SDKError CanChangeQuerySetting(bool& bCan) = 0;

    virtual SDKError ChangeQuerySettings(MeetingAICompanionQuerySettingOptions setting) = 0;

    virtual MeetingAICompanionQuerySettingOptions GetSelectedQuerySetting() = 0;

    virtual SDKError IsAICompanionQueryLegalNoticeAvailable(bool& bAvailable) = 0;

    virtual const zchar_t* GetAICompanionQueryLegalNoticesPrompt() = 0;

    virtual const zchar_t* GetAICompanionQueryLegalNoticesExplained() = 0;

    virtual SDKError IsAICompanionQueryPrivacyLegalNoticeAvailable(bool& bAvailable) = 0;

    virtual const zchar_t* GetAICompanionQueryPrivacyLegalNoticesPrompt() = 0;
};

class IAICompanionFeatureTurnOnAgainHandler
{
public:
    virtual ~IAICompanionFeatureTurnOnAgainHandler() {};
    virtual IList<AICompanionFeature>* GetFeatureList() = 0;
    virtual IList<AICompanionFeature>* GetAssetsDeletedFeatureList() = 0;
    virtual SDKError TurnOnAgain() = 0;
    virtual SDKError AgreeTurnOff() = 0;
};

class IAICompanionFeatureSwitchHandler
{
public:
    virtual ~IAICompanionFeatureSwitchHandler() {};
    virtual unsigned int GetRequestUserID() = 0;
    virtual const zchar_t* GetRequestUserName() = 0;
    virtual bool IsTurnOn() = 0;
    virtual SDKError Agree(bool bDeleteAssets) = 0;
    virtual SDKError Decline() = 0;
};
 

class IMeetingAICompanionCtrlEvent
{
public:
    virtual ~IMeetingAICompanionCtrlEvent() {}
    virtual void onAICompanionFeatureTurnOffByParticipant(IAICompanionFeatureTurnOnAgainHandler* handler) = 0;
    virtual void onAICompanionFeatureSwitchRequested(IAICompanionFeatureSwitchHandler* handler) = 0;
    virtual void onAICompanionFeatureSwitchRequestResponse(bool bTimeout, bool bAgree, bool bTurnOn) = 0;
    virtual void onAICompanionFeatureCanNotBeTurnedOff(IList<AICompanionFeature>* features) = 0;
    virtual void onHostUnsupportedStopNotesRequest() = 0;
};

class IMeetingAICompanionController
{
public:
    virtual SDKError SetEvent(IMeetingAICompanionCtrlEvent* pEvent) = 0;

    virtual IMeetingSmartSummaryHelper* GetMeetingSmartSummaryHelper() = 0;

    virtual IMeetingAICompanionSmartSummaryHelper* GetMeetingAICompanionSmartSummaryHelper() = 0;

    virtual IMeetingAICompanionQueryHelper* GetMeetingAICompanionQueryHelper() = 0;

    virtual bool IsTurnoffAllAICompanionsSupported() = 0;

    virtual bool IsTurnOnAllAICompanionsSupported() = 0;

    virtual bool CanTurnOffAllAICompanions() = 0;

    virtual bool CanTurnOnAllAICompanions() = 0;

    virtual SDKError TurnOffAllAICompanions(bool bDeleteAssets) = 0;

    virtual SDKError TurnOnAllAICompanions() = 0;

    virtual bool CanRequestTurnoffAllAICompanions() = 0;

    virtual bool CanRequestTurnOnAllAICompanions() = 0;

    virtual SDKError RequestTurnoffAllAICompanions() = 0;

    virtual SDKError RequestTurnOnAllAICompanions() = 0;
};
 
END_ZOOM_SDK_NAMESPACE
#endif