IChatMsgInfo Class Reference

Chat message interface. More...

#include <meeting_chat_interface.h>

Public Member Functions
virtual const zchar_t *	GetMessageID ()=0
	Get the message ID of the current message.
virtual unsigned int	GetSenderUserId ()=0
	Get the sender ID of the current message.
virtual const zchar_t *	GetSenderDisplayName ()=0
	Get the sender screen name of the current message.
virtual unsigned int	GetReceiverUserId ()=0
	Get the receiver ID of the current message.
virtual const zchar_t *	GetReceiverDisplayName ()=0
	Get the receiver screen name of the current message.
virtual const zchar_t *	GetContent ()=0
	Get the content of the current message.
virtual time_t	GetTimeStamp ()=0
	Get the timestamps of the current message.
virtual bool	IsChatToAll ()=0
	Determine if the current message is sent to all.
virtual bool	IsChatToAllPanelist ()=0
	Determine if the current message is sent to all the panelists.
virtual bool	IsChatToWaitingroom ()=0
	Determine if the current message is sent to waiting room.
virtual SDKChatMessageType	GetChatMessageType ()=0
	Get the chat message type of the current message.
virtual bool	IsComment ()=0
	Determine if the current message is a reply to another message.
virtual bool	IsThread ()=0
	Determine if the current message is part of a message thread, and can be directly replied to.
virtual IList< IRichTextStyleItem * > *	GetTextStyleItemList ()=0
	Get the current message's chat message font style list.
virtual IList< SegmentDetails > *	GetSegmentDetails ()=0
	Get the chat message segment content and style detail of the current message.
virtual const zchar_t *	GetThreadID ()=0
	Get the current message's thread ID.
virtual	~IChatMsgInfo ()

Detailed Description

Chat message interface.

Definition at line 227 of file meeting_chat_interface.h.

Constructor & Destructor Documentation

~IChatMsgInfo()

virtual IChatMsgInfo::~IChatMsgInfo ( )

inlinevirtual

Definition at line 309 of file meeting_chat_interface.h.

{};

Member Function Documentation

GetChatMessageType()

virtual SDKChatMessageType IChatMsgInfo::GetChatMessageType ( )

pure virtual

Get the chat message type of the current message.

Returns

If the function succeeds, the return value is the chat message type of the current message.

GetContent()

virtual const zchar_t * IChatMsgInfo::GetContent ( )

pure virtual

Get the content of the current message.

Returns

If the function succeeds, the return value is the pointer to the content of the current message. Otherwise failed, the return value is nullptr.

GetMessageID()

virtual const zchar_t * IChatMsgInfo::GetMessageID ( )

pure virtual

Get the message ID of the current message.

Returns

If the function succeeds, the return value is the message ID of the current message. Otherwise failed, the return value is the string of length zero(0)

GetReceiverDisplayName()

virtual const zchar_t * IChatMsgInfo::GetReceiverDisplayName ( )

pure virtual

Get the receiver screen name of the current message.

Returns

If the function succeeds, the return value is the receiver screen name of the current message. Otherwise failed, the return value is the string of length zero(0).

GetReceiverUserId()

virtual unsigned int IChatMsgInfo::GetReceiverUserId ( )

pure virtual

Get the receiver ID of the current message.

Returns

If the function succeeds, the return value is the receiver ID of the current message. ZERO(0) indicates that the message is sent to all. ONE(1) indicates that the messages are sent to all the panelists. Otherwise failed, the return value is negative ONE(-1).

GetSegmentDetails()

virtual IList< SegmentDetails > * IChatMsgInfo::GetSegmentDetails ( )

pure virtual

Get the chat message segment content and style detail of the current message.

When receiving rich-text messages, a list of isolated paragraphs is included, each formatted according to its style. Concatenating these paragraphs together forms the complete message text.

GetSenderDisplayName()

virtual const zchar_t * IChatMsgInfo::GetSenderDisplayName ( )

pure virtual

Get the sender screen name of the current message.

Returns

If the function succeeds, the return value is sender screen name of the current message. Otherwise failed, the return value is nullptr.

Remarks

If the message is sent to all or to all panelists, the return value will be nullptr.

GetSenderUserId()

virtual unsigned int IChatMsgInfo::GetSenderUserId ( )

pure virtual

Get the sender ID of the current message.

Returns

If the function succeeds, the return value is the sender ID of the current message. Otherwise failed, the return value is -1.

GetTextStyleItemList()

virtual IList< IRichTextStyleItem * > * IChatMsgInfo::GetTextStyleItemList ( )

pure virtual

Get the current message's chat message font style list.

Deprecated

This class is marked as deprecated

GetThreadID()

virtual const zchar_t * IChatMsgInfo::GetThreadID ( )

pure virtual

Get the current message's thread ID.

Returns

If the function succeeds, the return value is the current message's thread ID. Otherwise the function fails, and the return value is the string of length zero(0)

GetTimeStamp()

virtual time_t IChatMsgInfo::GetTimeStamp ( )

pure virtual

Get the timestamps of the current message.

Returns

If the function succeeds, the return value is the timestamps of the current message.

IsChatToAll()

virtual bool IChatMsgInfo::IsChatToAll ( )

pure virtual

Determine if the current message is sent to all.

Returns

TRUE indicates that the current message is sent to all. Otherwise not.

IsChatToAllPanelist()

virtual bool IChatMsgInfo::IsChatToAllPanelist ( )

pure virtual

Determine if the current message is sent to all the panelists.

Returns

TRUE indicates that the current message is sent to all the panelists. Otherwise not.

IsChatToWaitingroom()

virtual bool IChatMsgInfo::IsChatToWaitingroom ( )

pure virtual

Determine if the current message is sent to waiting room.

Returns

TRUE indicates that the current message is sent to waiting room. Otherwise not.

IsComment()

virtual bool IChatMsgInfo::IsComment ( )

pure virtual

Determine if the current message is a reply to another message.

Returns

TRUE indicates that the current message is a reply to another message. Otherwise the function fails and the message is a standalone message.

IsThread()

virtual bool IChatMsgInfo::IsThread ( )

pure virtual

Determine if the current message is part of a message thread, and can be directly replied to.

Returns

TRUE indicates that the current message is a part of a message thread. Otherwise, the function fails.