会话未读数
即时通讯客户端常常需要 对会话进行未读消息计数。
您可以使用 IMLib SDK 提供的接口直接获取会话中的未读消息数。具体能力如下：
- 获取所有会话（不含聊天室）中的未读消息总数（
getTotalUnreadCount） - 获取指定会话中的总未读消息数，或指定会话中指定消息类型的总未读消息数，或按会话类型获取总未读消息总数（
getUnreadCount）
在用户使用您的 App 时，UI 上未读计数可能需要发生变化，此时您可以清除会话中的未读数（clearUnreadCount）。
获取所有会话未读数
获取所有会话类型(除聊天室外)的未读数。
方法
Dart
Future<int> getTotalUnreadCount(String? channelId, {IRCIMIWGetTotalUnreadCountCallback? callback});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| channelId | String | 频道 ID，仅支持超级群使用，其他会话类型传 null 即可。 |
| callback | IRCIMIWGetTotalUnreadCountCallback | 获取所有未读数事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他 回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
IRCIMIWGetTotalUnreadCountCallback? callback = IRCIMIWGetTotalUnreadCountCallback(
onSuccess: (int? t) {
//...
},
onError: (int? code) {
//...
});
int? ret = await engine?.getTotalUnreadCount(channelId, callback:callback);
获取指定会话未读数
获取指定会话(除聊天室外)的所有未读消息个数。
方法
Dart
Future<int> getUnreadCount(RCIMIWConversationType type, String targetId, String? channelId, {IRCIMIWGetUnreadCountCallback? callback});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| type | RCIMIWConversationType | 会话类型 |
| targetId | String | 会话 ID |
| channelId | String | 频道 ID，仅支持超级群使用，其他会话类型传 null 即可。 |
| callback | IRCIMIWGetUnreadCountCallback | 获取会话未读数事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
IRCIMIWGetUnreadCountCallback? callback = IRCIMIWGetUnreadCountCallback(
onSuccess: (int? t) {
//...
},
onError: (int? code) {
//...
});
int? ret = await engine?.getUnreadCount(type, targetId, channelId, callback:callback);
按会话类型获取未读数
获取多个指定会话类型(除聊天室外)的未读数。
方法
Dart
Future<int> getUnreadCountByConversationTypes(List<RCIMIWConversationType> conversationTypes, String? channelId, bool contain, {IRCIMIWGetUnreadCountByConversationTypesCallback? callback});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| conversationTypes | List<RCIMIWConversationType> | 会话类型集合 |
| channelId | String | 频道 ID，仅支持超级群使用，其他会话类型传 null 即可。 |
| contain | bool | 是否包含免打扰消息的未读消息数。 |
| callback | IRCIMIWGetUnreadCountByConversationTypesCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
IRCIMIWGetUnreadCountByConversationTypesCallback? callback = IRCIMIWGetUnreadCountByConversationTypesCallback(
onSuccess: (int? t) {
//...
},
onError: (int? code) {
//...
});
int? ret = await engine?.getUnreadCountByConversationTypes(conversationTypesInt, channelId, contain, callback:callback);
清除指定会话未读数
清除指定会话(除聊天室外)的未读数。
方法
Dart
Future<int> clearUnreadCount(RCIMIWConversationType type, String targetId, String? channelId, int timestamp, {IRCIMIWClearUnreadCountCallback? callback});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| type | RCIMIWConversationType | 会话类型 |
| targetId | String | 会话 ID |
| channelId | String | 频道 ID，仅支持超级群使用，其他会话类型传 null 即可。 |
| timestamp | int | 该会话已阅读的最后一条消息的发送时间戳，清除所有传入当前最新时间戳 |
| callback | IRCIMIWClearUnreadCountCallback | 事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
IRCIMIWClearUnreadCountCallback? callback = IRCIMIWClearUnreadCountCallback(
onUnreadCountCleared: (int? code) {
//...
});
int? ret = await engine?.clearUnreadCount(type, targetId, channelId, timestamp, callback:callback);
加载所有@未读数
加载某个会话的所有@未读数
方法
Dart
Future<int> getUnreadMentionedCount(RCIMIWConversationType type, String targetId, String? channelId, {IRCIMIWGetUnreadMentionedCountCallback? callback});
参数说明
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| type | RCIMIWConversationType | 会话类型 |
| targetId | String | 会话 ID |
| channelId | String | 频道 ID，仅支持超级群使用，其他会话类型传 null 即可。 |
| callback | IRCIMIWGetUnreadMentionedCountCallback | 获取会话中未读的 @ 消息数量事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。 |
返回值
| 返回值 | 描述 |
|---|---|
| Future<int> | 当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码 |
代码示例
Dart
IRCIMIWGetUnreadMentionedCountCallback? callback = IRCIMIWGetUnreadMentionedCountCallback(
onSuccess: (int? t) {
//...
},
onError: (int? code) {
//...
});
int? ret = await engine?.getUnreadMentionedCount(type, targetId, channelId, callback:callback);