IMeetingChatHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_IMEETINGCHATHELPER_H
#define ZRC_IMEETINGCHATHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum MeetingChatPrivilegeType
{
    MeetingChatPrivilegeTypeUnknown = -1,           
    MeetingChatPrivilegeTypeAll = 1,                
    MeetingChatPrivilegeTypeAllPanelist,            
    MeetingChatPrivilegeTypeHost,                   
    MeetingChatPrivilegeTypeDisableAttendeeChat,    
    MeetingChatPrivilegeTypeHostPublic              
};
 
enum MeetingChatPanelistPrivilegeType
{
    MeetingChatPanelistPrivilegeTypeUnknown = -1,       
    MeetingChatPanelistPrivilegeTypeAllPanelist = 1,    
    MeetingChatPanelistPrivilegeTypeAll                 
};
 
enum MeetingChatMSGSendToType
{
    MeetingChatMSGSendToTypeUnknown = -1,                  
    MeetingChatMSGSendToTypeToAll = 0,                     
    MeetingChatMSGSendToTypeToPanelist = 1,                
    MeetingChatMSGSendToTypeToIndividualCcPanelist = 2,    
    MeetingChatMSGSendToTypeToIndividual = 3,              
    MeetingChatMSGSendToTypeToGreenRoom = 7,               
};
 
enum MeetingChatMessageType
{
    MeetingChatMessageType_UNKNOWN = 0,        
    MeetingChatMessageType_TEXT = 1,           
    MeetingChatMessageType_FILE = 2,           
    MeetingChatMessageType_IMAGE = 3,          
    MeetingChatMessageType_CMC_MEETING = 8,    
    MeetingChatMessageType_CMC_GROUP_CHAT =
        9,    
    MeetingChatMessageType_CMC_GUEST_JOIN_OR_LEFT = 10,    
    MeetingChatMessageType_REVOKE_MESSAGE = 11,            
};
 
enum MeetingChatMessageSubType
{
    MeetingChatMessageSubType_NOT_SET = 0,    
    MeetingChatMessageSubType_THREAD = 1,     
    MeetingChatMessageSubType_COMMENT = 2,    
};
 
enum MeetingChatMessageState
{
    MeetingChatMessageState_UNKNOWN = 0,     
    MeetingChatMessageState_SENDING = 1,     
    MeetingChatMessageState_SENT = 2,        
    MeetingChatMessageState_RECEIVED = 3,    
};
 
enum MeetingChatSyncType
{
    MeetingChatSyncType_UNKNOWN = 0,              
    MeetingChatSyncType_INIT = 1,                 
    MeetingChatSyncType_LOAD_MORE_HISTORY = 2,    
};
 
struct MeetingChatPrivilege
{
    MeetingChatPrivilegeType         type = MeetingChatPrivilegeTypeUnknown;                             
    bool                             isChatOff = false;                                                  
    bool                             isAttendeeChatAllowed = false;                                      
    MeetingChatPanelistPrivilegeType panelistPrivilegeType = MeetingChatPanelistPrivilegeTypeUnknown;    
};
 
struct ShareFileInMeetingChatParam
{
    std::string previewURL;      
    std::string downloadURL;     
    std::string fileName;        
    std::string thumbnailURL;    
    std::string fileSize;        
    std::string fileID;          
    std::string type;            
};
 
struct MeetingChatMessage
{
    int32_t                     index = 0;              
    std::string                 messageID;              
    std::string                 content;                
    bool                        isSelfSend = false;     
    MeetingChatMSGSendToType    msgSendToType = MeetingChatMSGSendToTypeUnknown;    
    bool                        isFile = false;         
    std::string                 fileURL;                
    std::string                 fileName;               
    int32_t                     fileSize = 0;           
    int32_t                     contentType = 0;        
    int32_t                     senderID = 0;           
    int32_t                     receiverID = 0;         
    std::string                 senderDisplayName;      
    std::string                 receiverDisplayName;    
    std::string                 timestamp;              
    bool                        isShareFileMessage = false; 
    ShareFileInMeetingChatParam shareFileInfo;          
    bool                        isDeleted = false;      
    bool                        canBeDeleted = false;   
    bool                        isEdited = false;       
};
 
struct ChatEmojiCountInfo
{
    std::string emoji;                  
    int64_t     count = 0;              
    int64_t     firstEmojiTime = 0;     
    bool        containMine = false;    
};
 
struct ChatEmojiComment
{
    std::string  guid;              
    int32_t      meetingUserID = 0; 
    std::string  displayName;       
    int64_t      time = 0;          
};
 
struct NewMeetingChatMessage
{
    std::string                     messageID;                
    std::string                     threadID;                 
    MeetingChatMessageType          type = MeetingChatMessageType_UNKNOWN;              
    MeetingChatMessageSubType       subType = MeetingChatMessageSubType_NOT_SET;        
    MeetingChatMSGSendToType        chatSendToType = MeetingChatMSGSendToTypeUnknown;   
    std::string                     body;                     
    bool                            isDeleted = false;        
    bool                            isNotExist = false;       
    bool                            isSupported = false;      
    MeetingChatMessageState         state = MeetingChatMessageState_UNKNOWN;            
    int64_t                         threadServerTime = 0;     
    int64_t                         messageServerTime = 0;    
    int64_t                         messageEditTime = 0;      
    std::string                     senderConfUserID;         
    int32_t                         senderMeetingUserID = 0;  
    std::string                     senderUserGUID;           
    std::string                     senderName;               
    std::string                     receiverConfUserID;       
    int32_t                         receiverMeetingUserID = 0;
    std::string                     receiverUserGUID;         
    std::string                     receiverName;             
    std::vector<ChatEmojiCountInfo> emojiList;                
    int64_t                         commentCount = 0;         
    int64_t                         meetingStartedRealTime = -1;
    int64_t                         meetingEndedRealTime = -1;  
    int64_t                         meetingRealDuration = -1;   
    std::string                     fileName;                 
    std::string                     fileID;                   
    bool                            fileCmcDownAttachPlain = false; 
    EncryptionAlgorithm             fileEncryptionAlgorithm = EncryptionAlgorithm_Unknown;  
    std::string                     fileE2EKey;               
    std::string                     fileE2EIv;                
    int64_t                         visibleTime = 0;          
    bool                            isSelfSend = false;       
    bool                            canBeDeleted = false;     
    bool                            canBeReplied = false;     
    bool                            isCurrentMeetingMessage = false; 
};
 
struct NewMeetingChatThreadItem
{
    NewMeetingChatMessage              thread;      
    std::vector<NewMeetingChatMessage> comments;    
};
 
struct ChatMessageSyncFilter
{
    MeetingChatSyncType       syncType = MeetingChatSyncType_UNKNOWN;               
    MeetingChatMessageSubType messageSubType = MeetingChatMessageSubType_NOT_SET;   
    uint32_t                  maxSize = 0;          
    std::string               threadID;             
    int64_t                   startVisibleTime = 0; 
};
 
class IMeetingChatHelperSink
{
public:
    virtual ~IMeetingChatHelperSink() {}
 
    virtual void OnChatDisplaySettingsNotification(bool isShowChatNotificationOnZR, bool isShowChatListOnZR) = 0;
 
    virtual void OnMeetingChatPrivilegeNotification(const MeetingChatPrivilege& chatPrivilege) = 0;
 
    // old meeting chat
 
    virtual void OnChatMessageResponse(int32_t result, int32_t action) = 0;
 
    virtual void OnMeetingChatMessagesNotification(const std::vector<MeetingChatMessage>& messages) = 0;
 
    // new meeting chat
 
    virtual void OnUpdateCMCInfo(bool isCMCForBackendEnabled, bool isTeamChatEnabled) = 0;
 
    virtual void OnUpdateCMCTip(bool needConfirm, const std::string& title, const std::string& message) = 0;
 
    virtual void OnIsReadyForLoadMessageChanged() = 0;
 
    virtual void OnThreadReceived(const NewMeetingChatMessage& thread) = 0;
 
     virtual void OnCommentReceived(const NewMeetingChatMessage& comment, const NewMeetingChatMessage& updatedThread) = 0;
 
    virtual void OnThreadSent(const NewMeetingChatMessage& thread) = 0;
 
    virtual void OnCommentSent(const NewMeetingChatMessage& comment, const NewMeetingChatMessage& updatedThread) = 0;
 
    virtual void OnThreadDeleted(const NewMeetingChatMessage& thread) = 0;
 
    virtual void OnCommentDeleted(const NewMeetingChatMessage& comment, const NewMeetingChatMessage& updatedThread) = 0;
 
    virtual void OnMessagesUpdated(const std::vector<NewMeetingChatMessage>& messages) = 0;
 
    virtual void OnEmojiUpdated(const std::vector<NewMeetingChatMessage>& messages) = 0;
 
    virtual void OnMessageLoaded(const ChatMessageSyncFilter& filter, bool result, const std::vector<NewMeetingChatMessage>& messages,
                                 bool hasMoreHistory, bool hasMoreRecent) = 0;
 
    virtual void OnEmojiDetail(const std::string& messageID, const std::string& emojiCode, bool isFirstPage, bool isLastPage,
                               const std::vector<ChatEmojiComment>& emojiSenders) = 0;
 
    virtual void OnSendMessageFailed() = 0;
};
 
class IMeetingChatHelper
{
public:
    virtual ~IMeetingChatHelper() {}
 
    virtual ZRCSDKError RegisterSink(IMeetingChatHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IMeetingChatHelperSink* pSink) = 0;
 
    // Check if new chat experience to choose the API set.
 
    virtual ZRCSDKError IsNewChatExperience(bool& isNewChat) = 0;
 
    virtual ZRCSDKError OpenChatPageOnZRC(bool open) = 0;
 
    // ==========================================================================
    // New Meeting Chat
    // ==========================================================================
 
    virtual ZRCSDKError ConfirmCMCTip() = 0;
 
    virtual ZRCSDKError IsRequiredConfirmCMCTip(bool& required) = 0;
 
    // ==========================================================================
    // New meeting chat messages load from most recent to history.
    // ==========================================================================
 
    virtual ZRCSDKError LoadThreadMessages() = 0;
 
    virtual ZRCSDKError LoadCommentMessages(const std::string& threadID) = 0;
 
    virtual ZRCSDKError SendNewChatMessage(const std::string& threadID, int32_t receiverMeetingUserID, MeetingChatMSGSendToType chatMSGType,
                                           const std::string& text) = 0;
 
    virtual ZRCSDKError DeleteNewChatMessage(const std::string& messageID) = 0;
 
    virtual ZRCSDKError EditNewChatMessage(const std::string& messageID, const std::string& text) = 0;
 
    virtual ZRCSDKError FetchNewChatEmojiDetail(const std::string& messageID, const std::string& emojiCode) = 0;
 
    virtual ZRCSDKError IsOnlySelectedEmojisEnabled(bool& isOnlySelectedEmojisEnabled) = 0;
 
    virtual ZRCSDKError GetSelectedEmojisForReaction(std::string& selectedEmojis) = 0;
 
    virtual ZRCSDKError ReactNewChatEmoji(const std::string& messageID, bool add, const std::string& emojiCode) = 0;
 
    // ==========================================================================
    // Help methods
    // ==========================================================================
 
    virtual ZRCSDKError IsReplyChatDisabled(bool& isReplyChatDisabled) = 0;
 
    virtual ZRCSDKError IsEditMessageEnabled(bool& isEditMessageEnabled) = 0;
 
    virtual ZRCSDKError IsReactEmojiEnabled(bool& isReactEmojiEnabled) = 0;
 
    virtual ZRCSDKError IsAllowHyperlinks(bool& isAllowHyperlinks) = 0;
 
    virtual ZRCSDKError IsReadyForLoadMessage(bool& isReadyForLoadMessage) = 0;
 
    virtual ZRCSDKError GetNewMeetingChatMessageList(std::vector<NewMeetingChatThreadItem>& messages) = 0;
 
    // ==========================================================================
    // Old meeting chat
    // ==========================================================================
 
    virtual ZRCSDKError FetchChatMessages(int32_t start, int32_t count) = 0;
 
    virtual ZRCSDKError DeleteChatMessage(const std::string& messageID) = 0;
 
    virtual ZRCSDKError SendChatMessage(int32_t receiverID, MeetingChatMSGSendToType type, const std::string& content) = 0;
 
    virtual ZRCSDKError GetOldMeetingChatMessages(std::vector<MeetingChatMessage>& messages) = 0;
 
    virtual ZRCSDKError GetWebinarChattedAttendees(std::vector<MeetingParticipant>& chattedAttendees) = 0;
 
    // ==========================================================================
    // Option control
    // ==========================================================================
 
    virtual ZRCSDKError ShowChatNotificationOnZR(bool show) = 0;
 
    virtual ZRCSDKError ShowChatListOnZR(bool show) = 0;
 
    virtual ZRCSDKError SetChatPrivilege(MeetingChatPrivilegeType type) = 0;
 
    virtual ZRCSDKError SetChatPanelistPrivilege(MeetingChatPanelistPrivilegeType type) = 0;
};
 
NS_ZRCSDK_END
 
#endif /* ZRC_IMEETINGCHATHELPER_H */