跳到主要内容

发送消息

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

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

发送普通消息

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

方法

sendMessage(
message: RCIMIWMessage,
callback: RCIMIWSendMessageCallback
): Promise<number>;

参数说明

参数名参数类型描述
messageRCIMIWMessage发送的消息实体
callbackRCIMIWSendMessageCallback发送消息的事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。

代码示例

let callback = {
onMessageSaved:(res) => {
//...
},
onMessageSent:(res) => {
//...
}};
let code = await engine.sendMessage(message, callback);

回调方法

  • setOnMessageAttachedListener

    消息存入数据库的监听

setOnMessageAttachedListener(listener?: ({message}) => void): void;

参数说明

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

代码示例

engine.setOnMessageAttachedListener((res) => {
//...
});
  • setOnMessageSentListener

    消息发送结果的监听

setOnMessageSentListener(listener?: ({code, message}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMessage发送的消息

代码示例

engine.setOnMessageSentListener((res) => {
//...
});

发送媒体消息

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

方法

sendMediaMessage(
message: RCIMIWMediaMessage,
listener: RCIMIWSendMediaMessageListener
): Promise<number>;

参数说明

参数名参数类型描述
messageRCIMIWMediaMessage发送的媒体消息实体
listenerRCIMIWSendMediaMessageListener发送媒体消息的事件监听

返回值

返回值描述
Promise<number>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。

代码示例

let listener = {
onMediaMessageSaved:(res) => {
//...
},
onMediaMessageSending:(res) => {
//...
},
onSendingMediaMessageCanceled:(res) => {
//...
},
onMediaMessageSent:(res) => {
//...
}};
let code = await engine.sendMediaMessage(message, listener);

回调方法

  • setOnMediaMessageAttachedListener

    消息存入数据库的监听

setOnMediaMessageAttachedListener(listener?: ({message}) => void): void;

参数说明

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

代码示例

engine.setOnMediaMessageAttachedListener((res) => {
//...
});
  • setOnMediaMessageSendingListener

    消息发送进度的监听

setOnMediaMessageSendingListener(listener?: ({message, progress}) => void): void;

参数说明

参数名参数类型描述
messageRCIMIWMediaMessage发送的消息
progressnumber发送的进度

代码示例

engine.setOnMediaMessageSendingListener((res) => {
//...
});
  • setOnMediaMessageSentListener

    消息发送结果的监听

setOnMediaMessageSentListener(listener?: ({code, message}) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
messageRCIMIWMediaMessage发送的消息

代码示例

engine.setOnMediaMessageSentListener((res) => {
//...
});