跳到主要内容

receipt-group

用户可以对自己发送的消息发起阅读回执请求,发起后,可以看到有多少人阅读过这条消息。

发起回执请求

发起消息已读回执请求。

方法

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

参数说明

参数类型说明
messageRCIMIWMessage需求请求回执的已发送消息

返回值

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

代码示例

engine.sendGroupReadReceiptRequest(message)
.then((code: number) => {});

回调方法

  • setOnGroupReadReceiptRequestSentListener

    接口调用结果的监听

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

参数说明

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

代码示例

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

监听群聊回执请求

方法

setOnGroupMessageReadReceiptRequestReceivedListener(listener?: (targetId: string, messageUId: string) => void): void;

参数说明

参数名参数类型描述
targetIdstring会话 ID
messageUIdstring消息的 messageUId

代码示例

engine.setOnGroupMessageReadReceiptRequestReceivedListener(
(
targetId: string,
messageUId: string
) => {}
);

响应回执请求

收到了回执请求,接收者需要响应该请求,通知对方已阅读此消息。可以一次响应同一会话中的多条消息。

方法

sendGroupReadReceiptResponse(targetId: string, channelId: string, messages: Array<RCIMIWMessage>): Promise<number>;

参数说明

参数类型说明
targetIdstring会话 ID
channelIdstring暂不支持该参数。传 null 即可。
messagesArray<RCIMIWMessage>会话中需要发送回执的消息列表

返回值

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

示例代码

engine.sendGroupReadReceiptResponse(
targetId,
channelId,
messages
)
.then((code: number) => {});

回调方法

  • setOnGroupReadReceiptResponseSentListener

    接口调用结果的监听

setOnGroupReadReceiptResponseSentListener(listener?: (code: number, targetId: string, channelId: string, messages: Array<RCIMIWMessage>) => void): void;

参数说明

参数名参数类型描述
codenumber接口回调的状态码,0 代表成功,非 0 代表出现异常
targetIdstring调用接口时传入的会话 ID
channelIdstring暂不支持该参数。传 null 即可。
messagesArray<RCIMIWMessage>调用接口时传入的消息列表

代码示例

engine.setOnGroupReadReceiptResponseSentListener(
(
code: number,
targetId: string,
channelId: string,
messages: Array<RCIMIWMessage>
) => {}
);

监听群聊回执响应

方法

setOnGroupMessageReadReceiptResponseReceivedListener(listener?: (targetId: string, messageUId: string, respondUserIds: Map<string, number>) => void): void;

参数说明

参数名参数类型描述
targetIdstring会话 ID
messageUIdstring收到回执响应的消息的 messageUId
respondUserIdsMap<string, number>会话中响应了此消息的用户列表。其中 key: 用户ID ; value: 响应时间。

代码示例

engine.setOnGroupMessageReadReceiptResponseReceivedListener(
(
targetId: string,
messageUId: string,
respondUserIds: Map<string, number>
) => {}
);