EMChatMessage类 参考

#import <EMChatMessage.h>

类 EMChatMessage 继承关系图:

构造函数
((unavailable("call initWithConversationID instead")	- __attribute__
(EMMessageReaction *_Nullable)	- getReaction:
(instancetype _Nonnull)	- initWithConversationID:from:to:body:ext:
(instancetype _Nonnull)	- initWithConversationID:body:ext:

属性
NSString *_Nonnull	messageId
NSString *_Nonnull	conversationId
EMMessageDirection	direction
NSString *_Nonnull	from
NSString *_Nonnull	to
long long	timestamp
long long	localTime
EMChatType	chatType
EMMessageStatus	status
BOOL	onlineState
BOOL	isReadAcked
BOOL	isChatThreadMessage
BOOL	isNeedGroupAck
int	groupAckCount
BOOL	isDeliverAcked
BOOL	isRead
BOOL	isListened
EMMessageBody *_Nonnull	body
NSArray< EMMessageReaction * > *_Nullable	reactionList
NSDictionary *_Nullable	ext
EMChatThread *_Nullable	chatThread
EMChatRoomMessagePriority	priority
BOOL	broadcast
BOOL	deliverOnlineOnly
NSArray< NSString * > *_Nullable	receiverList
BOOL	isContentReplaced
EMMessagePinInfo *_Nullable	pinnedInfo

详细描述

聊天消息类。

函数文档

- (EMMessageReaction *_Nullable) getReaction:

(NSString *_Nonnull)

reaction

根据 Reaction ID 获取 Reaction 内容。

参数

reaction

Reaction ID。

返回

Reaction 内容。

- (instancetype _Nonnull) initWithConversationID:		(NSString *_Nonnull)	aConversationId
body:		(EMMessageBody *_Nonnull)	aBody
ext:		(NSDictionary *_Nullable)	aExt

初始化消息实例。

参数

aConversationId	会话 ID。
aBody	消息体实例。
aExt	扩展信息。

返回

消息实例。

- (instancetype _Nonnull) initWithConversationID:		(NSString *_Nonnull)	aConversationId
from:		(NSString *_Nonnull)	aFrom
to:		(NSString *_Nonnull)	aTo
body:		(EMMessageBody *_Nonnull)	aBody
ext:		(NSDictionary *_Nullable)	aExt

初始化消息实例。

参数

aConversationId	会话 ID。
aFrom	消息发送方。
aTo	消息接收方。
aBody	消息体实例。
aExt	扩展信息。

返回

消息实例。

属性说明

- (EMMessageBody* _Nonnull) body

readwritenonatomicstrong

消息体。

- (BOOL) broadcast

readnonatomicassign

是否是全局广播消息。

- (EMChatThread* _Nullable) chatThread

readatomicassign

获取消息内的 thread 概览。

目前仅群组消息支持。

- (EMChatType) chatType

readwritenonatomicassign

聊天类型。

- (NSString* _Nonnull) conversationId

readwritenonatomiccopy

会话 ID，是会话的唯一标识。

- (BOOL) deliverOnlineOnly

readwritenonatomicassign

消息是否只投递给在线用户：

• YES：只有消息接收方在线时才能投递成功。若接收方离线，消息不投递。
• （默认）NO：无论接收方在线或离线，消息均投递。

- (EMMessageDirection) direction

readwritenonatomicassign

消息的方向。

- (NSDictionary* _Nullable) ext

readwritenonatomiccopy

自定义消息扩展。

该参数数据形式是一个 Key-Value 的键值对，其中 Key 为 NSString 型，Value 为 NSString、NSNumber 类型的 Bool、Int、Unsigned int、long long 或 double.

- (NSString* _Nonnull) from

readwritenonatomiccopy

消息的发送方。

- (int) groupAckCount

readnonatomicassign

收到的群组已读消息回执数量。

- (BOOL) isChatThreadMessage

readwritenonatomicassign

是否是在子区内发送的消息：

• YES: 是；
• NO: 否。

- (BOOL) isContentReplaced

readnonatomicassign

消息内容是否已被替换，开启EMOptions::useReplacedMessageContent后有效

- (BOOL) isDeliverAcked

readwritenonatomicassign

是否已发送或收到消息送达回执。

• YES: 是；
• NO: 否。

对于消息发送方，该属性表示是否已收到送达回执。

对于消息接收方，该属性表示是否已发送送达回执。

如果你将 EMOptions 中的 enableDeliveryAck 设为 YES，则 SDK 在收到消息后会自动发送送法回执。

- (BOOL) isListened

readwritenonatomicassign

语音消息是否已播放。

• YES: 是；
• NO: 否。

- (BOOL) isNeedGroupAck

readwritenonatomicassign

是否需要发送群组已读消息回执：

• YES: 是；
• NO: 否。

- (BOOL) isRead

readwritenonatomicassign

消息是否已读。

• YES: 是；
• NO: 否。

- (BOOL) isReadAcked

readwritenonatomicassign

是否（消息接收方）已发送或（消息发送方）已收到消息已读回执。

• YES: 是；
• NO: 否。

- (long long) localTime

readwritenonatomicassign

客户端发送或收到此消息的时间。

单位为毫秒。

- (NSString* _Nonnull) messageId

readwritenonatomiccopy

消息 ID，是消息的唯一标识。

- (BOOL) onlineState

readnonatomicassign

是否为在线消息：

• YES: 在线消息。
• NO: 离线消息。

消息的在线状态在本地数据库不存储。

从数据库读取或拉取的漫游消息默认值为在线。

- (EMMessagePinInfo* _Nullable) pinnedInfo

readnonatomicassign

消息的置顶操作信息。

若消息未置顶，返回 nil。

- (EMChatRoomMessagePriority) priority

readwritenonatomicassign

设置聊天室消息的到达优先级。

目前，该属性仅支持聊天室消息。默认值为 normal，表示普通优先级。

- (NSArray<EMMessageReaction *>* _Nullable) reactionList

readnonatomicassign

Reaction 列表。

- (NSArray<NSString*>* _Nullable) receiverList

readwritenonatomicstrong

定向消息的接收方。

该属性仅对群组和聊天室中的消息有效。若传入 nil，则消息发送给群组或聊天室的所有成员。

- (EMMessageStatus) status

readwritenonatomicassign

消息发送状态。详见 EMMessageStatus。

- (long long) timestamp

readwritenonatomicassign

服务器收到该消息的 Unix 时间戳，单位为毫秒。

- (NSString* _Nonnull) to

readwritenonatomiccopy

消息的接收方。

---

该类的文档由以下文件生成:

• HyphenateChat.framework/Headers/EMChatMessage.h