EMChatMessage类 参考

#import <EMChatMessage.h>

类 EMChatMessage 继承关系图:

构造函数
(EMMessageReaction *_Nullable)	- getReaction:
(id _Nonnull)	- initWithConversationID:from:to:body:ext:
(id _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	isChannelMessage
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

详细描述

聊天消息类。

函数文档

getReaction:

- (EMMessageReaction *_Nullable) getReaction:

(NSString *_Nonnull)

reaction

根据 Reaction ID 获取 Reaction 内容。

参数

reaction

Reaction ID。

返回

Reaction 内容。

initWithConversationID:body:ext:

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

初始化消息实例。

参数

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

返回

消息实例。

initWithConversationID:from:to:body:ext:

- (id _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	扩展信息。

返回

消息实例。

属性说明

body

- (EMMessageBody* _Nonnull) body

readwritenonatomicstrong

消息体。

chatThread

- (EMChatThread* _Nullable) chatThread

readatomicassign

获取消息内的thread概览（目前仅群组消息支持）

chatType

- (EMChatType) chatType

readwritenonatomicassign

消息类型。

conversationId

- (NSString* _Nonnull) conversationId

readwritenonatomiccopy

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

direction

- (EMMessageDirection) direction

readwritenonatomicassign

消息的方向。

ext

- (NSDictionary* _Nullable) ext

readwritenonatomiccopy

自定义消息扩展。

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

from

- (NSString* _Nonnull) from

readwritenonatomiccopy

消息的发送方。

groupAckCount

- (int) groupAckCount

readnonatomicassign

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

isChatThreadMessage

- (BOOL) isChatThreadMessage

readwritenonatomicassign

是否是在thread内发的消息

isDeliverAcked

- (BOOL) isDeliverAcked

readwritenonatomicassign

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

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

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

isListened

- (BOOL) isListened

readwritenonatomicassign

语音消息是否已播放。

• YES: 是；
• NO: 否。

isNeedGroupAck

- (BOOL) isNeedGroupAck

readwritenonatomicassign

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

• YES: 是；
• NO: 否。

isRead

- (BOOL) isRead

readwritenonatomicassign

消息是否已读。

• YES: 是；
• NO: 否。

isReadAcked

- (BOOL) isReadAcked

readwritenonatomicassign

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

• YES: 是；
• NO: 否。

localTime

- (long long) localTime

readwritenonatomicassign

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

messageId

- (NSString* _Nonnull) messageId

readwritenonatomiccopy

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

onlineState

- (BOOL) onlineState

readnonatomicassign

消息在线状态（本地数据库不存储，从数据库读取或拉取漫游消息默认值是 YES）

priority

- (EMChatRoomMessagePriority) priority

readwritenonatomicassign

设置聊天室消息的到达优先级（目前仅聊天室消息支持）不传默认为normal

reactionList

- (NSArray<EMMessageReaction *>* _Nullable) reactionList

readnonatomicassign

Reaction 列表。

status

- (EMMessageStatus) status

readwritenonatomicassign

消息发送状态。详见 EMMessageStatus。

timestamp

- (long long) timestamp

readwritenonatomicassign

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

to

- (NSString* _Nonnull) to

readwritenonatomiccopy

消息的接收方。

---

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

• HyphenateChat.framework/Headers/EMChatMessage.h