IChatMsgInfo Class Reference

Chat message interface. More...

#include <meeting_chat_interface.h>

Public Member Functions
virtual unsigned int	GetSenderUserId ()=0
	Get the sender ID of the current message. More...
virtual const wchar_t *	GetSenderDisplayName ()=0
	Get the sender screen name of the current message. More...
virtual unsigned int	GetReceiverUserId ()=0
	Get the receiver ID of the current message. More...
virtual const wchar_t *	GetReceiverDisplayName ()=0
	Get the receiver screen name of the current message. More...
virtual const wchar_t *	GetContent ()=0
	Get the content of the current message. More...
virtual time_t	GetTimeStamp ()=0
	Get the timestamps of the current message. More...
virtual bool	IsChatToAll ()=0
	Determine if the current message is sent to all. More...
virtual bool	IsChatToAllPanelist ()=0
	Determine if the current message is sent to all the panelists. More...
virtual bool	IsChatToWaitingroom ()=0
	Determine if the current message is sent to waiting room. More...
virtual SDKChatMessageType	GetChatMessageType ()=0
	Get the chat message type of the current message. More...

Detailed Description

Chat message interface.

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 wchar_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 NULL.

GetReceiverDisplayName()

virtual const wchar_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).

GetSenderDisplayName()

virtual const wchar_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 NULL.

Remarks

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

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.

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.

---

The documentation for this class was generated from the following file:

• h/meeting_service_components/meeting_chat_interface.h