Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKChatInfo Class Reference

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

#include <ZoomSDKMeetingActionController.h>

Inherits NSObject.

Instance Methods

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

Gets the current message's type.

Returns
The ZoomSDKChatMessageType.

References getChatMessageType.

Referenced by getChatMessageType.

◆ getMessageID

- (NSString *) getMessageID

Gets chat message ID.

Returns
If the function succeeds, it returns the ID of chat message. Otherwise, this function fails and returns nil.

References getMessageID.

Referenced by getMessageID.

◆ getMsgContent

- (NSString *) getMsgContent

Gets the content of message.

Returns
If the function succeeds, it returns the content of message. Otherwise, this function fails and returns nil.

References getMsgContent.

Referenced by getMsgContent.

◆ getReceiverDisplayName

- (NSString *) getReceiverDisplayName

Gets the screen name of receiver.

Returns
If the function succeeds, it returns the screen name. Otherwise, this function fails and returns nil.

References getReceiverDisplayName.

Referenced by getReceiverDisplayName.

◆ getReceiverUserID

- (unsigned int) getReceiverUserID

Gets the user ID of whom receiving the message.

Returns
If the function succeeds, it returns the user ID. Otherwise, returns -1.

References getReceiverUserID.

Referenced by getReceiverUserID.

◆ getSegmentDetails

- (NSArray< ZoomSDKChatMsgSegmentDetails * > *_Nullable) getSegmentDetails

Gets the list of segment details in the current message.

Returns
If the function succeeds, it returns an array of ZoomSDKChatMsgSegmentDetails objects representing rich text segments in the message. Otherwise, this function fails and returns nil.

References getSegmentDetails.

Referenced by getSegmentDetails.

◆ getSenderDisplayName

- (NSString *) getSenderDisplayName

Gets the sender's screen name.

Returns
If the function succeeds, it returns the screen name. Otherwise, this function fails and returns nil.

References getSenderDisplayName.

Referenced by getSenderDisplayName.

◆ getSenderUserID

- (unsigned int) getSenderUserID

Gets the user ID of whom sending message.

Returns
If the function succeeds, it returns the user ID of sender. Otherwise, returns -1.

References getSenderUserID.

Referenced by getSenderUserID.

◆ getTextStyleItemList

- (NSArray< ZoomSDKRichTextStyleItem * > *_Nullable) getTextStyleItemList

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

Deprecated
This method is no longer used.

References getTextStyleItemList.

Referenced by getTextStyleItemList.

◆ getThreadID

- (NSString *) getThreadID

Gets the current message’s thread ID.

Returns
If the function succeeds, it returns the current message’s thread ID. Otherwise, this function fails and it returns the string of length zero(0).

References getThreadID.

Referenced by getThreadID.

◆ getTimeStamp

- (time_t) getTimeStamp

Gets the current's timestamps message.

Returns
The current's timestamps message.

References getTimeStamp.

Referenced by getTimeStamp.

◆ isChatToWaitingRoom

- (BOOL) isChatToWaitingRoom

The current message is send to waiting room.

Returns
YES if the message is send to waiting room. Otherwise, NO.

References isChatToWaitingRoom.

Referenced by isChatToWaitingRoom.

◆ isComment

- (BOOL) isComment

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

Returns
YES if the current message is a reply to another message. Otherwise, NO.

References isComment.

Referenced by isComment.

◆ isThread

- (BOOL) isThread

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

Returns
YES if the current message is a part of a message thread. Otherwise, NO.

References isThread.

Referenced by isThread.

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.