• IMLib / IMKit >
 
• 无 UI SDK（IMLib） >
 
• 用户管理 >
 
• 黑名单管理

将用户加入黑名单之后，将不再收到对方发来的任何单聊消息。

• 加入黑名单为单向操作，例如：用户 A 拉黑用户 B，代表 B 无法给 A 发消息（错误码 405）。但 A 向 B 发消息，B 仍然能正常接收。
• 单个用户的黑名单总人数存在上限，具体与计费套餐有关。IM 旗舰版与 IM 尊享版上限为 3000 人，其他套餐详见功能对照表中的服务限制。
• 调用服务端 API 发送单聊消息默认不受黑名单限制。如需启用限制，请在调用 API 时设置 verifyBlacklist 为 1。

加入黑名单

将某个用户加入黑名单。

方法

 
Future<int> addToBlacklist(String userId, {IRCIMIWAddToBlacklistCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

回调方法

• onBlacklistAdded

 
Function(int? code, String? userId)? onBlacklistAdded;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onBlacklistAdded = (int? code, String? userId) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

移除黑名单

将某个用户从黑名单中移出。

方法

 
Future<int> removeFromBlacklist(String userId, {IRCIMIWRemoveFromBlacklistCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

回调方法

• onBlacklistRemoved

 
Function(int? code, String? userId)? onBlacklistRemoved;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onBlacklistRemoved = (int? code, String? userId) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

查询用户是否在黑名单中

获取某用户是否在黑名单中。

方法

 
Future<int> getBlacklistStatus(String userId, {IRCIMIWGetBlacklistStatusCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

回调方法

• onBlacklistStatusLoaded

 
Function(int? code, String? userId, RCIMIWBlacklistStatus? status)? onBlacklistStatusLoaded;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onBlacklistStatusLoaded = (int? code, String? userId, RCIMIWBlacklistStatus? status) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

获取黑名单列表

获取当前用户设置的黑名单列表。

方法

 
Future<int> getBlacklist({IRCIMIWGetBlacklistCallback? callback});
              

                
已复制
                复制代码
              
              
1

返回值

回调方法

• onBlacklistLoaded

 
Function(int? code, List<String>? userIds)? onBlacklistLoaded;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onBlacklistLoaded = (int? code, List<String>? userIds) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3