获取未读数
返回的未读数最大值为 999。如果实际未读数超过 999，接口仍返回 999。
获取所有超级群会话的未读消息数
获取当前用户加入的所有超级群会话的未读消息数的总和。
方法
getUltraGroupAllUnreadCount(
callback: IRCIMIWGetUltraGroupAllUnreadCountCallback
): Promise<number>;
返回值
| 返回值 | 描述 |
|---|---|
| Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。 |
代码示例
let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getUltraGroupAllUnreadCount(callback);
回调方法
- setOnUltraGroupAllUnreadCountLoadedListener
setOnUltraGroupAllUnreadCountLoadedListener(listener?: ({code, count}) => void): void;
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| code | number | 接口回调的状态码，0 代表成功，非 0 代表出现异常 |
| count | number | 未读数量 |
代码示例
engine.setOnUltraGroupAllUnreadCountLoadedListener((res) => {
//...
});
所有超级群会话中的未读 @ 消息数
获取当前用户加入的所有超级群会话中的未读 @ 消息数的总和。
方法
getUltraGroupAllUnreadMentionedCount(
callback: IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback
): Promise<number>;
返回值
| 返回值 | 描述 |
|---|---|
| Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。 |
代码示例
let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getUltraGroupAllUnreadMentionedCount(callback);
回调方法
- setOnUltraGroupAllUnreadMentionedCountLoadedListener
setOnUltraGroupAllUnreadMentionedCountLoadedListener(listener?: ({code, count}) => void): void;
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| code | number | 接口回调的状态码，0 代表成功，非 0 代表出现异常 |
| count | number | 未读数量 |
代码示例
engine.setOnUltraGroupAllUnreadMentionedCountLoadedListener((res) => {
//...
});
获取指定会话的未读消息数
获取当前用户加入的所有超级群会话的未读消息数的总和。
方法
getUltraGroupUnreadCount(
targetId: string,
callback: IRCIMIWGetUltraGroupUnreadCountCallback
): Promise<number>;
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| targetId | string | 会话 ID |
| callback | IRCIMIWGetUltraGroupUnreadCountCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Promise<number> | 当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。 |
代码示例
let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getUltraGroupUnreadCount(targetId, callback);
回调方法
- setOnUltraGroupUnreadCountLoadedListener
setOnUltraGroupUnreadCountLoadedListener(listener?: ({code, targetId, count}) => void): void;
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| code | number | None |
| targetId | string | None |
| count | number | None |
代码示例
engine.setOnUltraGroupUnreadCountLoadedListener((res) => {
//...
});
取超级群会话中被 @ 的消息数
获取超级群会话中被 @ 的消息数
方法
getUltraGroupUnreadMentionedCount(
targetId: string,
callback: IRCIMIWGetUltraGroupUnreadMentionedCountCallback
): Promise<number>;
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| targetId | string | 会话 ID |
| callback | IRCIMIWGetUltraGroupUnreadMentionedCountCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Promise<number> | 当次接口操作的状态 码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。 |
代码示例
let callback = {
onSuccess:(res) => {
//...
},
onError:(res) => {
//...
}};
let code = await engine.getUltraGroupUnreadMentionedCount(targetId, callback);
回调方法
- setOnUltraGroupUnreadMentionedCountLoadedListener
setOnUltraGroupUnreadMentionedCountLoadedListener(listener?: ({code, targetId, count}) => void): void;
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| code | number | 接口回调的状态码，0 代表成功，非 0 代表出现异常 |
| targetId | string | 会话 ID |
| count | number | 未读数量 |
代码示例
engine.setOnUltraGroupUnreadMentionedCountLoadedListener((res) => {
//...
});