meeting_chat_interface.h

Go to the documentation of this file.

#ifndef _MEETING_CHAT_INTERFACE_H_
#define _MEETING_CHAT_INTERFACE_H_
#include "zoom_sdk_def.h"
 
BEGIN_ZOOM_SDK_NAMESPACE
typedef enum
{
    SDKChatMessageType_To_None, 
    SDKChatMessageType_To_All,  
    SDKChatMessageType_To_All_Panelist,
    SDKChatMessageType_To_Individual_Panelist,
    SDKChatMessageType_To_Individual,
    SDKChatMessageType_To_WaitingRoomUsers,
}SDKChatMessageType;

struct BoldAttrs
{
    bool bBold = false; 
};

struct ItalicAttrs
{
    bool bItalic = false; 
};

struct StrikethroughAttrs
{
    bool bStrikethrough = false; 
};
 
// \brief BulletedList attributes.
struct BulletedListAttrs
{
    bool bBulletedList = false; 
};

struct NumberedListAttrs
{
    bool bNumberedList = false; 
};

struct UnderlineAttrs
{
    bool bUnderline = false; 
};

struct QuoteAttrs
{
    bool bQuote = false; 
};

struct InsertLinkAttrs {
    const zchar_t* insertLinkUrl = nullptr; 
};

#define RichTextStyle_FontSize_Small        _T("FontSize_Small")
#define RichTextStyle_FontSize_Medium       _T("FontSize_Medium")
#define RichTextStyle_FontSize_Large        _T("FontSize_Large")

#define FontSize_Small 8
#define FontSize_Medium 10
#define FontSize_Large 12

struct FontSizeAttrs {
    int fontSize = 0; 
};
 
struct FontColorAttrs {
    unsigned int red = 0; 
    unsigned int green = 0; 
    unsigned int blue = 0; 
};

struct BackgroundColorAttrs {
    unsigned int red = 0; 
    unsigned int green = 0; 
    unsigned int blue = 0; 
};

#define RichTextStyle_Paragraph_H1      _T("Paragraph_H1")
#define RichTextStyle_Paragraph_H2      _T("Paragraph_H2")
#define RichTextStyle_Paragraph_H3      _T("Paragraph_H3")
 
struct ParagraphAttrs {
    const zchar_t* strParagraph = nullptr; 
};

struct IndentAttrs {
    unsigned int indent = 0; 
};

struct SegmentDetails {
    const zchar_t* strContent = nullptr; 
    BoldAttrs boldAttrs = {}; 
    ItalicAttrs italicAttrs = {}; 
    StrikethroughAttrs strikethroughAttrs = {}; 
    BulletedListAttrs bulletedListAttrs = {}; 
    NumberedListAttrs numberedListAttrs = {}; 
    UnderlineAttrs underlineAttrs = {}; 
    QuoteAttrs quoteAttrs = {}; 
    InsertLinkAttrs insertLinkAttrs = {}; 
    FontSizeAttrs fontSizeAttrs = {}; 
    FontColorAttrs fontColorAttrs = {}; 
    BackgroundColorAttrs backgroundColorAttrs = {}; 
    ParagraphAttrs paragraphAttrs = {}; 
    IndentAttrs indentAttrs = {}; 
};

typedef enum
{
    TextStyle_None, 
    TextStyle_Bold, 
    TextStyle_Italic,
    TextStyle_Strikethrough, 
    TextStyle_BulletedList, 
    TextStyle_NumberedList, 
    TextStyle_Underline, 
    TextStyle_FontSize, 
    TextStyle_FontColor, 
    TextStyle_BackgroundColor, 
    TextStyle_Indent,
    TextStyle_Paragraph, 
    TextStyle_Quote, 
    TextStyle_InsertLink 
}RichTextStyle;

class IRichTextStyleOffset
{
public:
    virtual unsigned int GetPositionStart() = 0;

    virtual unsigned int GetPositionEnd() = 0;

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

class IRichTextStyleItem
{
public:
    virtual RichTextStyle GetTextStyle() = 0;

    virtual IList<IRichTextStyleOffset*>* GetTextStyleOffsetList() = 0;
};
 

class IChatMsgInfo
{
public:
    virtual const zchar_t* GetMessageID() = 0;

    virtual unsigned int GetSenderUserId() = 0;

    virtual const zchar_t* GetSenderDisplayName() = 0;

    virtual unsigned int GetReceiverUserId() = 0;

    virtual const zchar_t* GetReceiverDisplayName() = 0;

    virtual const zchar_t* GetContent() = 0;

    virtual time_t GetTimeStamp() = 0;

    virtual bool IsChatToAll() = 0;

    virtual bool IsChatToAllPanelist() = 0;

    virtual bool IsChatToWaitingroom() = 0;

    virtual SDKChatMessageType GetChatMessageType() = 0;

    virtual bool IsComment() = 0;

    virtual bool IsThread() = 0;

    virtual IList<SegmentDetails>* GetSegmentDetails() = 0;

    virtual const zchar_t* GetThreadID() = 0;
 
    virtual ~IChatMsgInfo() {};
};

typedef struct tagNormalMeetingChatStatus
{
    bool can_chat;
    bool can_chat_to_all;
    bool can_chat_to_individual;
    bool is_only_can_chat_to_host; 
}NormalMeetingChatStatus;

typedef struct tagWebinarAttendeeChatStatus
{
    bool can_chat; 
    bool can_chat_to_all_panellist_and_attendee;
    bool can_chat_to_all_panellist;
}WebinarAttendeeChatStatus;

typedef struct tagWebinarOtherUserRoleChatStatus
{
    bool can_chat_to_all_panellist;
    bool can_chat_to_all_panellist_and_attendee;
    bool can_chat_to_individual;
}WebinarOtherUserRoleChatStatus;

typedef struct tagChatStatus
{
    union
    {
        NormalMeetingChatStatus normal_meeting_status;
        WebinarAttendeeChatStatus webinar_attendee_status;
        WebinarOtherUserRoleChatStatus webinar_other_status;
    }ut;
    bool is_chat_off;
    bool is_webinar_attendee;
    bool is_webinar_meeting;
 
    tagChatStatus()
    {
        Reset();
    }
 
    void Reset()
    {
        memset(this, 0, sizeof(tagChatStatus));  //checked safe
    }
}ChatStatus;

typedef enum {
    SDK_CHAT_PRIVILEGE_ALL = 1, 
    SDK_CHAT_PRIVILEGE_ALL_PANELIST = 2,
    SDK_CHAT_PRIVILEGE_HOST = 3,    
    SDK_CHAT_PRIVILEGE_DISABLE_ATTENDEE_CHAT = 4,  
    SDK_CHAT_PRIVILEGE_HOST_PUBLIC = 5,              
    SDK_CHAT_PRIVILEGE_END
} SDKChatPrivilege;

typedef enum
{
    SDK_CHAT_DELETE_BY_NONE,    
    SDK_CHAT_DELETE_BY_SELF,    
    SDK_CHAT_DELETE_BY_HOST,    
    SDK_CHAT_DELETE_BY_DLP,     
}SDKChatMessageDeleteType;
 
 
typedef enum
{
    SDKFileTransferState_None = 0,
    SDKFileTransferState_ReadyToTransfer,  
    SDKFileTransferState_Transfering,  
    SDKFileTransferState_TransferFailed, 
    SDKFileTransferState_TransferDone,     
}SDKFileTransferStatus;

typedef struct tagSDKFileTransferInfo
{
    const zchar_t* messageID;
    SDKFileTransferStatus trans_status;
    time_t time_stamp;
    bool is_send_to_all;
    unsigned int file_size;
    const zchar_t* file_name;
    unsigned int complete_percentage;
    unsigned int complete_size;
    unsigned int bit_per_second;
    tagSDKFileTransferInfo()
    {
        Reset();
    }
 
    void Reset()
    {
        memset(this, 0, sizeof(tagSDKFileTransferInfo));  //checked safe
    }
}SDKFileTransferInfo;
 
class ISDKFileSender
{
public:
    virtual SDKFileTransferInfo* GetTransferInfo() = 0;
    virtual unsigned int GetReceiver() = 0;

    virtual SDKError CancelSend() = 0;
 
    virtual ~ISDKFileSender() {};
};
 
class ISDKFileReceiver
{
public:
    virtual SDKFileTransferInfo* GetTransferInfo() = 0;

    virtual unsigned int GetSender() = 0;

    virtual SDKError CancelReceive() = 0;

    virtual SDKError StartReceive(const zchar_t* path) = 0;
 
    virtual ~ISDKFileReceiver() {};
};
 

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

    virtual void onChatMsgNotification(IChatMsgInfo* chatMsg, const zchar_t* content = nullptr) = 0;

    virtual void onChatStatusChangedNotification(ChatStatus* status_) = 0;

    virtual void onChatMsgDeleteNotification(const zchar_t* msgID, SDKChatMessageDeleteType deleteBy) = 0;

    virtual void onChatMessageEditNotification(IChatMsgInfo* chatMsg) = 0;
 
    virtual void onShareMeetingChatStatusChanged(bool isStart) = 0;

    virtual void onFileSendStart(ISDKFileSender* sender) = 0;

    virtual void onFileReceived(ISDKFileReceiver* receiver) = 0;

    virtual void onFileTransferProgress(SDKFileTransferInfo* info) = 0;
 
};

class IChatMsgInfoBuilder
{
public:
    virtual IChatMsgInfoBuilder* SetContent(const zchar_t* content) = 0;

    virtual IChatMsgInfoBuilder* SetReceiver(unsigned int receiver) = 0;

    virtual IChatMsgInfoBuilder* SetThreadId(const zchar_t* threadId) = 0;

    virtual IChatMsgInfoBuilder* SetMessageType(SDKChatMessageType type) = 0;

    virtual IChatMsgInfoBuilder* SetQuotePosition(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetQuotePosition(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetInsertLink(InsertLinkAttrs insertLink, unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetInsertLink(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetFontSize(FontSizeAttrs fontSize, unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetFontSize(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetItalic(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetItalic(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetBold(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetBold(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetStrikethrough(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetStrikethrough(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetBulletedList(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetBulletedList(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetNumberedList(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetNumberedList(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetUnderline(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetUnderline(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetFontColor(FontColorAttrs color, unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetFontColor(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* SetBackgroundColor(BackgroundColorAttrs color, unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetBackgroundColor(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* IncreaseIndent(IndentAttrs indent, unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* DecreaseIndent(IndentAttrs indent, unsigned int positionStart, unsigned int positionEnd) = 0;
 

    virtual IChatMsgInfoBuilder* SetParagraph(ParagraphAttrs paragraph, unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* UnsetParagraph(unsigned int positionStart, unsigned int positionEnd) = 0;

    virtual IChatMsgInfoBuilder* ClearStyles() = 0;

    virtual IChatMsgInfoBuilder* Clear() = 0;

    virtual IChatMsgInfo* Build() = 0;
 
    virtual ~IChatMsgInfoBuilder() {}
};

class IMeetingChatController
{
public:
    virtual SDKError SetEvent(IMeetingChatCtrlEvent* pEvent) = 0;

    virtual const ChatStatus* GetChatStatus() = 0;

    virtual SDKError SetParticipantsChatPrivilege(SDKChatPrivilege privilege) = 0;

    virtual bool IsMeetingChatLegalNoticeAvailable() = 0;

    virtual const zchar_t* getChatLegalNoticesPrompt() = 0;

    virtual const zchar_t* getChatLegalNoticesExplained() = 0;

    virtual bool IsShareMeetingChatLegalNoticeAvailable() = 0;

    virtual const zchar_t* GetShareMeetingChatStartedLegalNoticeContent() = 0;

    virtual const zchar_t* GetShareMeetingChatStoppedLegalNoticeContent() = 0;

    virtual bool IsChatMessageCanBeDeleted(const zchar_t* msgID) = 0;

    virtual SDKError DeleteChatMessage(const zchar_t* msgID) = 0;

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

    virtual IChatMsgInfo* GetChatMessageById(const zchar_t* msgID) = 0;

    virtual IChatMsgInfoBuilder* GetChatMessageBuilder() = 0;

    virtual SDKError SendChatMsgTo(IChatMsgInfo* msg) = 0;
  
    virtual bool IsFileTransferEnabled() = 0;

    virtual SDKError TransferFile(const zchar_t* filePath, unsigned int userid) = 0;

    virtual SDKError TransferFileToAll(const zchar_t* filePath) = 0;

    virtual const zchar_t* GetTransferFileTypeAllowList() = 0;

    virtual unsigned long long GetMaxTransferFileSizeBytes() = 0;
};
END_ZOOM_SDK_NAMESPACE
#endif