Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingChat Class Reference

Retrieve the meeting chat data. More...

#include <MobileRTCMeetingChat.h>

Inherits NSObject.

Properties

NSString *_Nullable chatId
 The message ID.
 
NSString *_Nullable senderId
 The ID of user who sends message.
 
NSString *_Nullable senderName
 The screen name of user who sends message.
 
NSString *_Nullable receiverId
 The ID of user who receives message.
 
NSString *_Nullable receiverName
 The screen name of user who receives message.
 
NSString *_Nullable content
 The message content.
 
NSDate *_Nullable date
 The message timestamps.
 
MobileRTCChatMessageType chatMessageType
 The Chat message type.
 
BOOL isMyself
 Whether the message is sent by the user himself or not.
 
BOOL isPrivate
 Whether the message is private or not.
 
BOOL isChatToAll
 Whether the message is send to all or not.
 
BOOL isChatToAllPanelist
 Whether the message is send to all panelist or not.
 
BOOL isChatToWaitingroom
 Whether the message is send to waiting room or not.
 
BOOL isComment
 Determine if the current message is a comment replying to another message.
 
BOOL isThread
 Determine if the current message is part of a message thread. and can be directly replied to.
 
NSArray< MobileRTCRichTextStyleItem * > *_Nullable textStyleItemList
 Get the current message’s chat message font style list.
 
NSArray< MobileRTCSegmentDetails * > *_Nullable segmentDetails
 Get the chat message segment content and style detail of the current message.
 
NSString *_Nullable threadID
 Get the current message’s thread ID.
 

Detailed Description

Retrieve the meeting chat data.

Warning
The function is optional.

Definition at line 654 of file MobileRTCMeetingChat.h.

Property Documentation

◆ chatId

- (NSString* _Nullable) chatId
readwritenonatomiccopy

The message ID.

Definition at line 658 of file MobileRTCMeetingChat.h.

◆ chatMessageType

- (MobileRTCChatMessageType) chatMessageType
readwritenonatomicassign

The Chat message type.

Definition at line 687 of file MobileRTCMeetingChat.h.

◆ content

- (NSString* _Nullable) content
readwritenonatomiccopy

The message content.

Definition at line 678 of file MobileRTCMeetingChat.h.

◆ date

- (NSDate* _Nullable) date
readwritenonatomicretain

The message timestamps.

Definition at line 682 of file MobileRTCMeetingChat.h.

◆ isChatToAll

- (BOOL) isChatToAll
readwritenonatomicassign

Whether the message is send to all or not.

Definition at line 700 of file MobileRTCMeetingChat.h.

◆ isChatToAllPanelist

- (BOOL) isChatToAllPanelist
readwritenonatomicassign

Whether the message is send to all panelist or not.

Definition at line 704 of file MobileRTCMeetingChat.h.

◆ isChatToWaitingroom

- (BOOL) isChatToWaitingroom
readwritenonatomicassign

Whether the message is send to waiting room or not.

Definition at line 708 of file MobileRTCMeetingChat.h.

◆ isComment

- (BOOL) isComment
readwritenonatomicassign

Determine if the current message is a comment replying to another message.

Definition at line 712 of file MobileRTCMeetingChat.h.

◆ isMyself

- (BOOL) isMyself
readwritenonatomicassign

Whether the message is sent by the user himself or not.

Definition at line 692 of file MobileRTCMeetingChat.h.

◆ isPrivate

- (BOOL) isPrivate
readwritenonatomicassign

Whether the message is private or not.

Definition at line 696 of file MobileRTCMeetingChat.h.

◆ isThread

- (BOOL) isThread
readwritenonatomicassign

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

Definition at line 716 of file MobileRTCMeetingChat.h.

◆ receiverId

- (NSString* _Nullable) receiverId
readwritenonatomiccopy

The ID of user who receives message.

Definition at line 670 of file MobileRTCMeetingChat.h.

◆ receiverName

- (NSString* _Nullable) receiverName
readwritenonatomiccopy

The screen name of user who receives message.

Definition at line 674 of file MobileRTCMeetingChat.h.

◆ segmentDetails

- (NSArray<MobileRTCSegmentDetails *>* _Nullable) segmentDetails
readwritenonatomiccopy

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

Note
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.

Definition at line 727 of file MobileRTCMeetingChat.h.

◆ senderId

- (NSString* _Nullable) senderId
readwritenonatomiccopy

The ID of user who sends message.

Definition at line 662 of file MobileRTCMeetingChat.h.

◆ senderName

- (NSString* _Nullable) senderName
readwritenonatomiccopy

The screen name of user who sends message.

Definition at line 666 of file MobileRTCMeetingChat.h.

◆ textStyleItemList

- (NSArray<MobileRTCRichTextStyleItem *>* _Nullable) textStyleItemList
readwritenonatomiccopy

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

Deprecated
Use segmentDetails instead.

Definition at line 721 of file MobileRTCMeetingChat.h.

◆ threadID

- (NSString* _Nullable) threadID
readwritenonatomiccopy

Get the current message’s thread ID.

Definition at line 731 of file MobileRTCMeetingChat.h.