receiptPrivate
发送已读回执
当 A 给 B 发送一条消息,B 用户调用发送阅读回执接口之后,A 用户可在回执监听中收到已读通知。
方法
sendPrivateReadReceiptMessage(targetId: string, channelId: string, timestamp: number): Promise<number>;
参数说明
参数 | 类型 | 说明 |
---|---|---|
targetId | string | 接收回执方的用户 ID |
channelId | string | 频道 ID,暂不支持该参数。传 null 即可。 |
timestamp | number | 会话中已读的最后一条消息的发送时间戳,即 message 的 sentTime |
返回值
返回值 | 描述 |
---|---|
Promise<number> | 当次接口操作状态码,并不代表最终操作结果,状态码详细信息 |
代码示例
engine.sendPrivateReadReceiptMessage(
targetId,
channelId,
timestamp
)
.then((code: number) => {});
回调方法
-
onPrivateReadReceiptMessageSent
接口调用结果的监听
setOnPrivateReadReceiptMessageSentListener(listener?: (code: number, targetId: string, channelId: string, timestamp: number) => void): void;
参数说明
参数名 | 参数类型 | 描述 |
---|---|---|
code | number | 接口回调的状态码,0 代表成功,非 0 代表出现异常 |
targetId | string | 调用接口时传入的 ID |
channelId | string | 调用接口时传入的频道 ID, |
timestamp | number | 调用接口时传入的时间戳 |
代码示例
engine.setOnPrivateReadReceiptMessageSentListener(
(
code: number,
targetId: string,
channelId: string,
timestamp: number
) => {}
);
设置消息回执监听器
设置消息回执监听器, 用于接收消息回执。
方法
setOnPrivateReadReceiptReceivedListener(listener?: (targetId: string, channelId: string, timestamp: number) => void): void;
参数说明
参数 | 类型 | 说明 |
---|---|---|
targetId | string | 发送回执的会话 ID |
channelId | string | 频道 ID |
timestamp | number | 已读的最后一条消息的发送时间戳 |
代码示例
engine.setOnPrivateReadReceiptReceivedListener(
(
targetId: string,
channelId: string,
timestamp: number
) => {}
);