单聊消息回执
发送已读回执
当 A 给 B 发送一条消息,B 用户调用发送阅读回执接口之后,A 用户可在回执监听中收到已读通知。
方法
sendPrivateReadReceiptMessage(
targetId: string,
channelId: string,
timestamp: number,
callback: IRCIMIWSendPrivateReadReceiptMessageCallback
): Promise<number>;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
timestamp | number | 该会话中已读的最后一条消息的发送时间戳 |
callback | IRCIMIWSendPrivateReadReceiptMessageCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。 |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考状态码文档。 |
代码示例
let callback = {
onPrivateReadReceiptMessageSent:(res) => {
//...
}};
let code = await engine.sendPrivateReadReceiptMessage(targetId, channelId, timestamp, callback);
回调方法
-
setOnPrivateReadReceiptMessageSentListener
接口调用结果的监听
setOnPrivateReadReceiptMessageSentListener(listener?: ({code, targetId, channelId, timestamp}) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会 话类型传 null 即可。 |
timestamp | number | 时间戳 |
代码示例
engine.setOnPrivateReadReceiptMessageSentListener((res) => {
//...
});
设置消息回执监听器
设置消息回执监听器, 用于接收消息回执。
方法
setOnPrivateReadReceiptReceivedListener(listener?: ({targetId, channelId, timestamp}) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
targetId | string | 会话 ID |
channelId | string | 频道 ID,仅支持超级群使用,其他会话类型传 null 即可。 |
timestamp | number | 已 阅读的最后一条消息的 sendTime |
代码示例
engine.setOnPrivateReadReceiptReceivedListener((res) => {
//...
});