IZoomVideoSDKChatMessage Class Reference

Chat message interface. More...

#include <zoom_video_sdk_chat_message_interface.h>

Public Member Functions
virtual	~IZoomVideoSDKChatMessage ()
virtual const zchar_t *	getMessageID ()=0
	Get the message ID of the current message.
virtual IZoomVideoSDKUser *	getSendUser ()=0
	Gets the sender user object of the message. When the message is sent from a broadcast streaming viewer, this function returns nullptr.
virtual const zchar_t *	getSendName ()=0
	Gets the sender's display name. This function returns the sender's name for both session users and broadcast streaming viewers.
virtual IZoomVideoSDKUser *	getReceiveUser ()=0
	Gets the receiver user object of the message.
virtual const zchar_t *	getContent ()=0
	Gets the content of the message.
virtual time_t	getTimeStamp ()=0
	Get the time stamp of the message.
virtual bool	isChatToAll ()=0
	Determines if the message is send to all.
virtual bool	isSelfSend ()=0
	Determines if the message is send by yourself.

Detailed Description

Chat message interface.

Definition at line 16 of file zoom_video_sdk_chat_message_interface.h.

Constructor & Destructor Documentation

~IZoomVideoSDKChatMessage()

virtual IZoomVideoSDKChatMessage::~IZoomVideoSDKChatMessage ( )

inlinevirtual

Definition at line 19 of file zoom_video_sdk_chat_message_interface.h.

{}

Member Function Documentation

getContent()

virtual const zchar_t * IZoomVideoSDKChatMessage::getContent ( )

pure virtual

Gets the content of the message.

Returns

The content of the message.

getMessageID()

virtual const zchar_t * IZoomVideoSDKChatMessage::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, this function fails and returns the string of length zero(0).

getReceiveUser()

virtual IZoomVideoSDKUser * IZoomVideoSDKChatMessage::getReceiveUser ( )

pure virtual

Gets the receiver user object of the message.

Returns

If the function succeeds, it returns the receiver user object. Otherwise, this function fails and returns nullptr.

getSendName()

virtual const zchar_t * IZoomVideoSDKChatMessage::getSendName ( )

pure virtual

Gets the sender's display name. This function returns the sender's name for both session users and broadcast streaming viewers.

Returns

If the function succeeds, it returns the sender's display name. Otherwise, this function fails and returns nullptr.

getSendUser()

virtual IZoomVideoSDKUser * IZoomVideoSDKChatMessage::getSendUser ( )

pure virtual

Gets the sender user object of the message. When the message is sent from a broadcast streaming viewer, this function returns nullptr.

Returns

If the function succeeds, it returns the sender user object. Otherwise, this function fails and returns nullptr.

getTimeStamp()

virtual time_t IZoomVideoSDKChatMessage::getTimeStamp ( )

pure virtual

Get the time stamp of the message.

Returns

The time stamp of the message.

isChatToAll()

virtual bool IZoomVideoSDKChatMessage::isChatToAll ( )

pure virtual

Determines if the message is send to all.

Returns

true if the message is send to all. Otherwise, false.

isSelfSend()

virtual bool IZoomVideoSDKChatMessage::isSelfSend ( )

pure virtual

Determines if the message is send by yourself.

Returns

true if the message is send by yourself. Otherwise, false.