IMeetingReminderHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGREMINDERHELPER_H
#define ZRC_IMEETINGREMINDERHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum MeetingReminderType
{
    REMINDER_TYPE_NONE = -1,                   
    REMINDER_TYPE_START_OR_JOIN_MEETING,       
    REMINDER_TYPE_JOIN_EXTERNAL_MEETING,       
    REMINDER_TYPE_RECORDING_REMINDER,          
    REMINDER_TYPE_RECORDING_DISCLAIMER,        
    REMINDER_TYPE_ARCHIVING_FAIL,              
    REMINDER_TYPE_JOIN_WEBINAR_AS_PANELIST,    
};
 
enum CustomizedMeetingReminderType
{
    CUSTOMIZED_REMINDER_TYPE_NONE = 0,                      
    CUSTOMIZED_REMINDER_TYPE_ONZOOM_JOIN_AS_PANELIST = 1    
};
 
enum ConsentType
{
    CONSENT_TYPE_NONE = -1,               
    CONSENT_TYPE_LIVE_STREAMING = 0,      
    CONSENT_TYPE_PROMOTED_TO_PANELIST,    
    CONSENT_TYPE_ARCHIVING,               
    CONSENT_TYPE_NDI,                     
    CONSENT_TYPE_FOCUS_MODE_START,        
    CONSENT_TYPE_FOCUS_MODE_ENDING,       
    CONSENT_TYPE_ADMIN_PAY_REMIND,        
    CONSENT_TYPE_PAC,                     
    CONSENT_TYPE_ZOOM_PHONE_ACR,          
    CONSENT_TYPE_HDMI_CONNECTED,          
    CONSENT_TYPE_MEETING_SUMMARY,         
    CONSENT_TYPE_MEETING_QUERY,           
    CONSENT_TYPE_CUSTOM_AI_COMPANION,     
    CONSENT_TYPE_COMMON,                  
};
 
enum PrivacyAlertType
{
    PRIVACY_ALERT_TYPE_LIVE_TRANSCRIPTION = 0,    
    PRIVACY_ALERT_TYPE_NEW_LTT_CAPTION = 1,       
};
 
enum PrivacyAlertAction
{
    PRIVACY_ALERT_ACTION_NONE = 0,               
    PRIVACY_ALERT_ACTION_SHOW = 1,               
    PRIVACY_ALERT_ACTION_CLOSE = 2,              
    PRIVACY_ALERT_ACTION_SHOW_DISCLAIMER = 3,    
    PRIVACY_ALERT_ACTION_CLOSE_DISCLAIMER = 4    
};
 
enum MessageEvent
{
    MESSAGE_EVENT_UNKNOWN = 0,                                              
    MESSAGE_EVENT_OpenVideoFailForHostStop = 1,                             
    MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserOptionDisabled = 2,  
    MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButUserNoGreenScreen = 3,   
    MESSAGE_EVENT_OpenVideoFailForForceVBEnabledButDeviceNotSupport = 4     
};
 
struct PrivacyMessage
{
    std::string privacyMessage;    
    std::string hyperlinkKey;      
    std::string hyperlinkURL;      
};
 
struct DisclaimerPrivacy
{
    std::string title;                
    PrivacyMessage privacyMessage;    
    std::string message;              
    std::string linkUrl;              
    std::string linkText;             
    std::string positiveActionText;   
    std::string negativeActionText;   
    std::string privacySection;       
};
 
struct MeetingReminderContent
{
    MeetingReminderType reminderType = REMINDER_TYPE_NONE;    
    DisclaimerPrivacy   disclaimerPrivacy;                    
    bool                isShowing = false;                    
};
 
struct CustomizedMeetingReminderContent
{
    int32_t customizedDisclaimerType = 0;   
    DisclaimerPrivacy disclaimerPrivacy;    
    bool              isShowing = false;    
};
 
struct CombinedConsent
{
    bool isShowing = false;                 
    int64_t type = 0;                       
    DisclaimerPrivacy disclaimerPrivacy;    
};
 
struct ConsentInfo
{
    ConsentType       type = CONSENT_TYPE_NONE;    
    DisclaimerPrivacy disclaimer;                  
    bool              isShowing = false;           
    std::string       consentID;                   
};
 
class IMeetingReminderHelperSink
{
public:
    ~IMeetingReminderHelperSink() {}
 
    virtual void OnMeetingReminderNotification(const MeetingReminderContent& reminderContent) = 0;
 
    virtual void OnCustomizedReminderNotification(const CustomizedMeetingReminderContent& customizedContent) = 0;
 
    virtual void OnCombinedConsentNotification(const CombinedConsent& combinedConsent) = 0;
 
    virtual void OnConsentNotification(const ConsentInfo& info) = 0;
 
    virtual void OnPrivacyAlertNotification(PrivacyAlertAction action, PrivacyAlertType type, const DisclaimerPrivacy& message) = 0;
 
    virtual void OnMessageEventNotification(MessageEvent messageEvent) = 0;
 
    virtual void OnInactiveDetectionNotification(bool isShowPrompt, time_t autoEndTime) = 0;
};
 
class IMeetingReminderHelper
{
public:
    virtual ~IMeetingReminderHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingReminderHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingReminderHelperSink* pSink) = 0;
 
    virtual ZRCSDKError ConfirmMeetingReminder(bool isAgree, MeetingReminderType reminderType) = 0;
 
    virtual ZRCSDKError ConfirmCustomizedMeetingReminder(bool isAgree, int32_t customizedDisclaimerType) = 0;
 
    virtual ZRCSDKError ConfirmConsent(bool isAgree, ConsentType type, const std::string& consentID = {}) = 0;
 
    virtual ZRCSDKError ConfirmCombinedConsent(bool agree, int64_t consentType) = 0;
 
    virtual ZRCSDKError HandlePrivacyAlert(PrivacyAlertAction action, PrivacyAlertType type) = 0;
 
    virtual ZRCSDKError ContinueMeetingOnInactivity() = 0;
};
 
NS_ZRCSDK_END
 
#endif    //ZRC_IMEETINGREMINDERHELPER_H