Meeting SDK for Linux API Reference
Loading...
Searching...
No Matches
meeting_chat_interface.h File Reference

Meeting Service Chat Interface. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Data Structures

struct  BoldAttrs
 Bold attributes. More...
 
struct  ItalicAttrs
 
struct  StrikethroughAttrs
 
struct  BulletedListAttrs
 
struct  NumberedListAttrs
 
struct  UnderlineAttrs
 
struct  QuoteAttrs
 
struct  InsertLinkAttrs
 
struct  FontSizeAttrs
 
struct  FontColorAttrs
 
struct  BackgroundColorAttrs
 
struct  ParagraphAttrs
 
struct  IndentAttrs
 
struct  SegmentDetails
 information of rich text with style attributes in a chat message content. Here are more detailed structural descriptions.. More...
 
class  IRichTextStyleOffset
 Chat message rich text style offset. More...
 
class  IRichTextStyleItem
 Chat message rich text item of a certain style. More...
 
class  IChatMsgInfo
 Chat message interface. More...
 
struct  tagNormalMeetingChatStatus
 
struct  tagWebinarAttendeeChatStatus
 The authority to chat for the normal attendee in the webinar. Here are more detailed structural descriptions.. More...
 
struct  tagWebinarOtherUserRoleChatStatus
 The authority to chat for the host, co-host and panelist to chat in webinar. Here are more detailed structural descriptions.. More...
 
struct  tagChatStatus
 The authority to chat in the specified meeting. Here are more detailed structural descriptions.. More...
 
struct  tagSDKFileTransferInfo
 The basic information of transfer file. More...
 
class  ISDKFileSender
 
class  ISDKFileReceiver
 
class  IMeetingChatCtrlEvent
 Meeting chat callback event. More...
 
class  IChatMsgInfoBuilder
 Chat message builder to create ChatMsgInfo objects. Tips: If there are duplicate styles, the final appearance is determined by the last applied setting. More...
 
class  IMeetingChatController
 Meeting chat controller interface. More...
 

Macros

#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
 
#define RichTextStyle_Paragraph_H1   _T("Paragraph_H1")
 
#define RichTextStyle_Paragraph_H2   _T("Paragraph_H2")
 
#define RichTextStyle_Paragraph_H3   _T("Paragraph_H3")
 

Typedefs

typedef struct tagNormalMeetingChatStatus NormalMeetingChatStatus
 
typedef struct tagWebinarAttendeeChatStatus WebinarAttendeeChatStatus
 
typedef struct tagWebinarOtherUserRoleChatStatus WebinarOtherUserRoleChatStatus
 
typedef struct tagChatStatus ChatStatus
 
typedef struct tagSDKFileTransferInfo SDKFileTransferInfo
 The basic information of transfer file.
 

Enumerations

enum  SDKChatMessageType {
  SDKChatMessageType_To_None , SDKChatMessageType_To_All , SDKChatMessageType_To_All_Panelist , SDKChatMessageType_To_Individual_Panelist ,
  SDKChatMessageType_To_Individual , SDKChatMessageType_To_WaitingRoomUsers
}
 Enumerations of the type for chat message. More...
 
enum  RichTextStyle {
  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
}
 Enumerations of the content rich text style type for chat message. More...
 
enum  SDKChatPrivilege {
  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
}
 Enumerations of the chat priviledge. More...
 
enum  SDKChatMessageDeleteType { SDK_CHAT_DELETE_BY_NONE , SDK_CHAT_DELETE_BY_SELF , SDK_CHAT_DELETE_BY_HOST , SDK_CHAT_DELETE_BY_DLP }
 Enumerations of the chat message delete type. More...
 
enum  SDKFileTransferStatus {
  SDKFileTransferState_None = 0 , SDKFileTransferState_ReadyToTransfer , SDKFileTransferState_Transfering , SDKFileTransferState_TransferFailed ,
  SDKFileTransferState_TransferDone
}
 

Detailed Description

Meeting Service Chat Interface.

Remarks
Valid for both ZOOM style and user custom interface mode.

Definition in file meeting_chat_interface.h.

Macro Definition Documentation

◆ FontSize_Large

#define FontSize_Large   12

Definition at line 81 of file meeting_chat_interface.h.

◆ FontSize_Medium

#define FontSize_Medium   10

Definition at line 80 of file meeting_chat_interface.h.

◆ FontSize_Small

#define FontSize_Small   8

Currently supported font size value.

Definition at line 79 of file meeting_chat_interface.h.

◆ RichTextStyle_FontSize_Large

#define RichTextStyle_FontSize_Large   _T("FontSize_Large")

Definition at line 74 of file meeting_chat_interface.h.

◆ RichTextStyle_FontSize_Medium

#define RichTextStyle_FontSize_Medium   _T("FontSize_Medium")

Definition at line 73 of file meeting_chat_interface.h.

◆ RichTextStyle_FontSize_Small

#define RichTextStyle_FontSize_Small   _T("FontSize_Small")

Definition at line 72 of file meeting_chat_interface.h.

◆ RichTextStyle_Paragraph_H1

#define RichTextStyle_Paragraph_H1   _T("Paragraph_H1")

The attribute strParagraph can be set with value below. If need customized paragraph text style, define strParagraph as the name of the customized text style and it will be shown in IChatMsgInfo.

Definition at line 129 of file meeting_chat_interface.h.

◆ RichTextStyle_Paragraph_H2

#define RichTextStyle_Paragraph_H2   _T("Paragraph_H2")

Definition at line 130 of file meeting_chat_interface.h.

◆ RichTextStyle_Paragraph_H3

#define RichTextStyle_Paragraph_H3   _T("Paragraph_H3")

Definition at line 131 of file meeting_chat_interface.h.

Typedef Documentation

◆ ChatStatus

typedef struct tagChatStatus ChatStatus

◆ NormalMeetingChatStatus

◆ SDKFileTransferInfo

The basic information of transfer file.

◆ WebinarAttendeeChatStatus

◆ WebinarOtherUserRoleChatStatus

Enumeration Type Documentation

◆ RichTextStyle

Enumerations of the content rich text style type for chat message.

Enumerator
TextStyle_None 

Chat message rich text style normal.

TextStyle_Bold 

Chat message rich text style bold.

TextStyle_Italic 

Chat message rich text style italic.

TextStyle_Strikethrough 

Chat message rich text style strike through.

TextStyle_BulletedList 

Chat message rich text style bulleted list.

TextStyle_NumberedList 

Chat message rich text style numbered list.

TextStyle_Underline 

Chat message rich text style underline.

TextStyle_FontSize 

Chat message rich text style font size.

TextStyle_FontColor 

Chat message rich text style font color.

TextStyle_BackgroundColor 

Chat message rich text style background color.

TextStyle_Indent 

Chat message rich text style indent.

TextStyle_Paragraph 

Chat message rich text style paragraph.

TextStyle_Quote 

Chat message rich text style quote.

TextStyle_InsertLink 

Chat message rich text style insert link.

Definition at line 168 of file meeting_chat_interface.h.

169{
RichTextStyle
Enumerations of the content rich text style type for chat message.
@ TextStyle_Underline
Chat message rich text style underline.
@ TextStyle_Quote
Chat message rich text style quote.
@ TextStyle_Strikethrough
Chat message rich text style strike through.
@ TextStyle_None
Chat message rich text style normal.
@ TextStyle_Indent
Chat message rich text style indent.
@ TextStyle_BackgroundColor
Chat message rich text style background color.
@ TextStyle_BulletedList
Chat message rich text style bulleted list.
@ TextStyle_InsertLink
Chat message rich text style insert link.
@ TextStyle_Bold
Chat message rich text style bold.
@ TextStyle_FontColor
Chat message rich text style font color.
@ TextStyle_FontSize
Chat message rich text style font size.
@ TextStyle_Paragraph
Chat message rich text style paragraph.
@ TextStyle_NumberedList
Chat message rich text style numbered list.
@ TextStyle_Italic
Chat message rich text style italic.

◆ SDKChatMessageDeleteType

Enumerations of the chat message delete type.

Enumerator
SDK_CHAT_DELETE_BY_NONE 

none

SDK_CHAT_DELETE_BY_SELF 

delete by self

SDK_CHAT_DELETE_BY_HOST 

delete by host

SDK_CHAT_DELETE_BY_DLP 

delete by dlp when the message goes against the host organization's compliance policies.

Definition at line 388 of file meeting_chat_interface.h.

389{
SDKChatMessageDeleteType
Enumerations of the chat message delete type.
@ SDK_CHAT_DELETE_BY_HOST
delete by host
@ SDK_CHAT_DELETE_BY_NONE
none
@ SDK_CHAT_DELETE_BY_DLP
delete by dlp when the message goes against the host organization's compliance policies.
@ SDK_CHAT_DELETE_BY_SELF
delete by self

◆ SDKChatMessageType

Enumerations of the type for chat message.

Enumerator
SDKChatMessageType_To_None 

For initialize

SDKChatMessageType_To_All 

Chat message is send to all.

SDKChatMessageType_To_All_Panelist 

Chat message is send to all panelists.

SDKChatMessageType_To_Individual_Panelist 

Chat message is send to individual attendee and cc panelists.

SDKChatMessageType_To_Individual 

Chat message is send to individual user.

SDKChatMessageType_To_WaitingRoomUsers 

Chat message is send to waiting room user.

Definition at line 14 of file meeting_chat_interface.h.

15{
SDKChatMessageType
Enumerations of the type for chat message.
@ SDKChatMessageType_To_None
For initialize
@ SDKChatMessageType_To_WaitingRoomUsers
Chat message is send to waiting room user.
@ SDKChatMessageType_To_Individual
Chat message is send to individual user.
@ SDKChatMessageType_To_All
Chat message is send to all.
@ SDKChatMessageType_To_Individual_Panelist
Chat message is send to individual attendee and cc panelists.
@ SDKChatMessageType_To_All_Panelist
Chat message is send to all panelists.

◆ SDKChatPrivilege

Enumerations of the chat priviledge.

Enumerator
SDK_CHAT_PRIVILEGE_ALL 

allow attendee to chat with everyone [meeting & webinar]

SDK_CHAT_PRIVILEGE_ALL_PANELIST 

allow attendee to chat with all panelists only, but cannot to "all panelists and attendees" [webinar]

SDK_CHAT_PRIVILEGE_HOST 

allow attendee to chat with host only [meeting]

SDK_CHAT_PRIVILEGE_DISABLE_ATTENDEE_CHAT 

allow attendee to chat with no one [meeting & webinar]

SDK_CHAT_PRIVILEGE_HOST_PUBLIC 

allow attendee to chat with host and public [meeting]

SDK_CHAT_PRIVILEGE_END 

Definition at line 376 of file meeting_chat_interface.h.

376 {
SDKChatPrivilege
Enumerations of the chat priviledge.
@ SDK_CHAT_PRIVILEGE_ALL
allow attendee to chat with everyone [meeting & webinar]
@ SDK_CHAT_PRIVILEGE_HOST
allow attendee to chat with host only [meeting]
@ SDK_CHAT_PRIVILEGE_END
@ SDK_CHAT_PRIVILEGE_HOST_PUBLIC
allow attendee to chat with host and public [meeting]
@ SDK_CHAT_PRIVILEGE_ALL_PANELIST
allow attendee to chat with all panelists only, but cannot to "all panelists and attendees" [webinar]
@ SDK_CHAT_PRIVILEGE_DISABLE_ATTENDEE_CHAT
allow attendee to chat with no one [meeting & webinar]

◆ SDKFileTransferStatus

Enumerator
SDKFileTransferState_None 

The file transfer has no state.

SDKFileTransferState_ReadyToTransfer 

The file transfer is ready to start.

SDKFileTransferState_Transfering 

The file transfer is in progress.

SDKFileTransferState_TransferFailed 

The file transfer failed.

SDKFileTransferState_TransferDone 

The file transfer completed successfully.

Definition at line 397 of file meeting_chat_interface.h.

398{
@ SDKFileTransferState_Transfering
The file transfer is in progress.
@ SDKFileTransferState_None
The file transfer has no state.
@ SDKFileTransferState_ReadyToTransfer
The file transfer is ready to start.
@ SDKFileTransferState_TransferDone
The file transfer completed successfully.
@ SDKFileTransferState_TransferFailed
The file transfer failed.