消息介绍
消息基本结构
属性名 | 类型 | 说明 |
---|---|---|
conversationType | RCIMIWConversationType | 会话类型 |
targetId | String | 会话 ID |
channelId | String | 所属会话的业务标识,长度限制 20 字符,仅在超级群下生效 |
messageType | RCIMIWMessageType | 消息的类型 |
messageId | int | 本地存储的消息的唯一值(数据库索引唯一值) |
messageUId | String | 服务器消息唯一 ID(在同一个 Appkey 下全局唯一) |
direction | RCIMIWMessageDirection | 消息的方向 |
receivedTime | int | 消息的接收时间(Unix 时间戳、毫秒) |
sentTime | int | 消息的发送时间(Unix 时间戳、毫秒) |
receivedStatus | RCIMIWReceivedStatus | 消息的接收状态 |
sentStatus | RCIMIWSentStatus | 消息的发送状态 |
senderUserId | String | 消息的发送者 ID |
expansion | Map | 消息扩展信息列表,该属性在消息发送时确定,发送之后不能再做修改。 扩展信息只支持单聊和群组,其它会话类型不能设置扩展信息。 默认消息扩展字典 key 长度不超过 32 ,value 长度不超过 4096 ,单次设置扩展数量最大为 20,消息的扩展总数不能超过 300 |
offLine | bool | 是否是离线消息,只在接收消息的回调方法中有效,如果消息为离线消息,则为 YES ,其他情况均为 NO |
groupReadReceiptInfo | RCIMIWGroupReadReceiptInfo | 群阅读回执状态 |
userInfo | RCIMIWUserInfo | 消息携带的用户信息 |
mentionedInfo | RCIMIWMentionedInfo | 消息的 @ 信息 |
pushOptions | RCIMIWMessagePushOptions | 消息推送配置,仅可在发送方进行配置,接收方为空 |
extra | String | 消息的附加字段,设置后接收方收到消息后也可以拿到数据。 |
消息类型与构造方法
IMLib 的消息类型(RCIMIWMessageType)枚举提供了预定义的文本、语音、图片等消息类型,并且支持 App 通过 RCIMIWMessageType.custom
实现自定义消息。
各类型消息默认会在客户端本地存储,计入未读消息数。以下类型除外:
- 撤回消息类型(
RCIMIWMessageType.recall
):客户端本地存储,但不计入未读消息数 - 命令消息类型(
RCIMIWMessageType.command
):客户端不进行本地存储,不计入未读消息数 - 命令通知消息类型(
RCIMIWMessageType.commandNotification
):客户端本地存储,不计入未读消息数。 - 自定义消息类型(
RCIMIWMessageType.custom
):由 App 自定义存储策略(RCIMIWCustomMessagePolicy)进行控制。
文本消息
类型:RCIMIWMessageType.text
专有可访问属性:
属性名 | 类型 | 说明 |
---|---|---|
text | String | 文本内容 |
构建文本消息
RCIMIWTextMessage? message = await engine.createTextMessage(
type,
targetId,
channelId,
text,
);
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型, |
targetId | String | 会话 ID |
channelId | String | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
text | String | 文本内容 |
语音消息
类型:RCIMIWMessageType.voice
专有可访问属性:
属性名 | 类型 | 说明 |
---|---|---|
duration | int | 语音的长度,单位:秒 |
构建语音消息
RCIMIWVoiceMessage? message = await engine.createVoiceMessage(
type,
targetId,
channelId,
path,
duration,
);
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | String | 会话 ID |
channelId | String | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
path | String | 语音消息的本地路径,必须为有效路径 |
duration | int | 语音消息的消息时长 |
图片消息
类型:RCIMIWMessageType.image
专有可访问属性:
属性名 | 类型 | 说明 |
---|---|---|
thumbnailBase64String | String | 图片的缩略图数据 |
original | bool | 是否为原图 |
构建图片消息
RCIMIWImageMessage? message = await engine.createImageMessage(
type,
targetId,
channelId,
path,
);
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | String | 会话 ID |
channelId | String | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
path | String | 图片消息的本地路径,必须为有效路径 |
文件消息
类型:RCIMIWMessageType.file
专有可访问属性:
属性名 | 类型 | 说明 |
---|---|---|
name | String | 文件名 |
fileType | String | 文件类型 |
size | int | 文件大小,单位为 Byte |
构建文件消息
RCIMIWFileMessage? message = await engine.createFileMessage(
type,
targetId,
channelId,
path,
);
参数名 | 参数类型 | 描述 |
---|---|---|
type | RCIMIWConversationType | 会话类型 |
targetId | String | 会话 ID |
channelId | String | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
path | String | 文件消息的本地路径,必须为有效路径 |
小视频消息
类型:RCIMIWMessageType.sight
专有可访问属性:
属性名 | 类型 | 说明 |
---|---|---|
duration | int | 视频时长 |
size | int | 视频大小 |
name | String | 视频的名称 |
thumbnailBase64String | String | 缩略图数据 |
构建小视频消息
RCIMIWSightMessage? message = await engine.createSightMessage(
type,
targetId,
channelId,
path,
duration,
);