ZoomSDKChatInfo Class Reference

Represents a chat message in the meeting. More...

#include <ZoomSDKMeetingActionController.h>

Inherits NSObject.

Instance Methods
(unsigned int)	- getSenderUserID
	Get the user ID of whom sending message.
(NSString *)	- getSenderDisplayName
	Get the screen name of the sender.
(unsigned int)	- getReceiverUserID
	Get the user ID of whom receiving the message.
(NSString *)	- getReceiverDisplayName
	Get the screen name of receiver.
(NSString *)	- getMsgContent
	Get the content of message.
(time_t)	- getTimeStamp
	Get the timestamps of the current message.
(BOOL)	- isChatToWaitingRoom
	The current message is send to waiting room.
(ZoomSDKChatMessageType)	- getChatMessageType
	Get the type of the current message.
(NSString *)	- getMessageID
	Get chat message ID.
(BOOL)	- isComment
	Determine if the current message is a reply to another message.
(BOOL)	- isThread
	Determine if the current message is part of a message thread, and can be directly replied to.
(NSArray< ZoomSDKRichTextStyleItem * > *_Nullable)	- getTextStyleItemList
	Get the current message’s chat message font style list.
(NSArray< ZoomSDKChatMsgSegmentDetails * > *_Nullable)	- getSegmentDetails
	Get the list of segment details in the current message.
(NSString *)	- getThreadID
	Get the current message’s thread ID.

Protected Attributes
unsigned int	_sendID
unsigned int	_receiverID
NSString *	_sendName
NSString *	_receiverName
NSString *	_content
time_t	_timestamp
BOOL	_isChatToWaitingRoom
ZoomSDKChatMessageType	_chatMessageType

Detailed Description

Represents a chat message in the meeting.

Definition at line 52 of file ZoomSDKMeetingActionController.h.

Method Documentation

getChatMessageType

- (ZoomSDKChatMessageType) getChatMessageType

Get the type of the current message.

Returns

If the function succeeds, the return value is the enum of ZoomSDKChatMessageType.

getMessageID

- (NSString *) getMessageID

Get chat message ID.

Returns

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

getMsgContent

- (NSString *) getMsgContent

Get the content of message.

Returns

If the function succeeds, the return value is the content of message.

getReceiverDisplayName

- (NSString *) getReceiverDisplayName

Get the screen name of receiver.

Returns

If the function succeeds, the return value is the screen name.

getReceiverUserID

- (unsigned int) getReceiverUserID

Get the user ID of whom receiving the message.

Returns

If the function succeeds, the return value is the user ID.

getSegmentDetails

- (NSArray< ZoomSDKChatMsgSegmentDetails * > *_Nullable) getSegmentDetails

Get the list of segment details in the current message.

Returns

If the function succeeds, the return value is an array of ZoomSDKChatMsgSegmentDetails objects representing rich text segments in the message. Otherwise nil.

getSenderDisplayName

- (NSString *) getSenderDisplayName

Get the screen name of the sender.

Returns

If the function succeeds, the return value is the screen name.

getSenderUserID

- (unsigned int) getSenderUserID

Get the user ID of whom sending message.

Returns

If the function succeeds, the return value is the user ID of sender.

getTextStyleItemList

- (NSArray< ZoomSDKRichTextStyleItem * > *_Nullable) getTextStyleItemList

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

Deprecated

This method is no longer used.

getThreadID

- (NSString *) getThreadID

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

- (time_t) getTimeStamp

Get the timestamps of the current message.

Returns

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

isChatToWaitingRoom

- (BOOL) isChatToWaitingRoom

The current message is send to waiting room.

Returns

If return YES means the message is send to waiting room, otherwise not.

isComment

- (BOOL) isComment

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

Returns

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

isThread

- (BOOL) isThread

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

Returns

YES indicates that the current message is a part of a message thread. Otherwise the function fails and return NO.

Field Documentation

_chatMessageType

- (ZoomSDKChatMessageType) _chatMessageType

protected

Definition at line 61 of file ZoomSDKMeetingActionController.h.

_content

- (NSString*) _content

protected

Definition at line 58 of file ZoomSDKMeetingActionController.h.

_isChatToWaitingRoom

- (BOOL) _isChatToWaitingRoom

protected

Definition at line 60 of file ZoomSDKMeetingActionController.h.

_receiverID

- (unsigned int) _receiverID

protected

Definition at line 55 of file ZoomSDKMeetingActionController.h.

_receiverName

- (NSString*) _receiverName

protected

Definition at line 57 of file ZoomSDKMeetingActionController.h.

_sendID

- (unsigned int) _sendID

protected

Definition at line 54 of file ZoomSDKMeetingActionController.h.

_sendName

- (NSString*) _sendName

protected

Definition at line 56 of file ZoomSDKMeetingActionController.h.

_timestamp

- (time_t) _timestamp

protected

Definition at line 59 of file ZoomSDKMeetingActionController.h.