send

本文介绍了 IMLib 如何发送消息。

客户端 SDK 发送消息存在频率限制，每秒最多只能发送 5 条消息。

发送普通消息

开发者在发送文本消息、引用消息、自定义普通消息时，可以使用下面接口发送。

方法

sendMessage(message: RCIMIWMessage): Promise<number>;

参数说明

参数名	类型
message	RCIMIWMessage	发送的消息实体

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

engine.sendMessage(message)
.then((code) => {});

回调方法

• setOnMessageAttachedListener

  消息存入数据库的监听

setOnMessageAttachedListener(listener?: (message: RCIMIWMessage) => void): void;

参数说明

参数名	参数类型	描述
message	RCIMIWMessage	已存入数据库的 message 对象

代码示例

engine.setOnMessageAttachedListener((message: RCIMIWMessage) => {});

• setOnMessageSentListener

  消息发送结果的监听

setOnMessageSentListener(listener?: (code: number, message: RCIMIWMessage) => void): void;

参数说明

参数名	参数类型	描述
code	number	发送的状态码
message	RCIMIWMessage	已存入数据库的 message 对象

代码示例

engine.setOnMessageSentListener((code: number, message: RCIMIWMessage) => {});

发送媒体消息

开发者在发送图片消息、语音消息、视频消息、文件消息、GIF 消息时，可以使用下面接口发送。

方法

sendMediaMessage(message: RCIMIWMediaMessage): Promise<number>;

参数说明

参数名	类型
message	RCIMIWMediaMessage	发送的媒体消息实体

返回值

返回值	描述
Promise<number>	当次接口操作状态码，并不代表最终操作结果，状态码详细信息

代码示例

engine.sendMediaMessage(message)
.then((code) => {});

回调方法

• setOnMediaMessageAttachedListener

  消息存入数据库的监听

setOnMediaMessageAttachedListener(listener?: (message: RCIMIWMediaMessage) => void): void;

参数说明

参数名	参数类型	描述
message	RCIMIWMediaMessage	发送的消息

代码示例

engine.setOnMediaMessageAttachedListener((message: RCIMIWMediaMessage) => {});

• setOnMediaMessageSendingListener

  消息发送进度的监听

setOnMediaMessageSendingListener(listener?: (message: RCIMIWMediaMessage, progress: number) => void): void;

参数说明

参数名	参数类型	描述
message	RCIMIWMediaMessage	正在发送的消息
progress	number	当前发送的进度

代码示例

engine.setOnMediaMessageSendingListener((message: RCIMIWMediaMessage, progress: number) => {});

• setOnMediaMessageSentListener

  消息发送结果的监听

setOnMediaMessageSentListener(listener?: (code: number, message: RCIMIWMediaMessage) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
message	RCIMIWMediaMessage	调用接口时传入的消息对象

代码示例

engine.setOnMediaMessageSentListener((code: number, message: RCIMIWMediaMessage) => {});

如何处理消息发送失败

对于客户端本地会存储的消息类型（参见消息介绍），如果触发消息入库的回调（setOnMessageAttachedListener / setOnMediaMessageAttachedListener），表示此时该消息已存入本地数据库，并已进入本地消息列表。

• 如果入库成功后消息发送失败（未能触发 setOnMessageSentListener / setOnMediaMessageSentListener），App 可以在 UI 临时展示这条发送失败的消息，并缓存 onMessageAttached 抛出的消息实例，在合适的时机重新调用 sendMessage / sendMediaMessage 发送。请注意，如果不复用该消息实例，而是重发相同内容的新消息，本地消息列表中会存储内容重复的两条消息。
• 如果入库失败，您可以检查参数是否合法，设备存储是否可正常写入。

对于客户端本地不存储的消息，如果发送失败（未能触发 setOnMessageSentListener/setOnMediaMessageSentListener），App 可缓存消息实例再重试发送，或直接新建消息实例进行发送。

如何实现转发、群发消息

转发消息：IMLib SDK 未提供转发消息接口。App 实现转发消息效果时，可调用发送消息接口发送。

群发消息：群发消息是指向多个用户发送消息。更准确地说，是向多个 Target ID^?发送消息，一个 Target ID 可能代表一个用户，一个群组，或一个聊天室。客户端 SDK 未提供直接实现群发消息效果的 API。您可以考虑以下实现方式：

• App 循环调用客户端的发送消息 API。请注意，客户端 SDK 限制发送消息的频率上限为每秒 5 条。
• App 在业务服务端接入即时通讯服务端 API（IM Server API），由 App 业务服务端群发消息。IM Server API 的 发送单聊消息 接口支持单次向多个用户发送单聊消息。您也可以通过 发送群聊消息、发送聊天室消息接口实现单次向多个群组或多个聊天室发送消息。