tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

Android&iOS&Windows&Mac

PDF
聚焦模式
字号
最后更新时间: 2025-01-03 10:36:20

功能描述

如果您需屏蔽某人的消息,可以把该用户拉入黑名单。

黑名单

拉黑某人

您可以调用 addToBlackList (Java / Swift / Objective-C / C++) 接口把某用户加入黑名单,即拉黑该用户。 如果您事先调用 addFriendListener 添加了监听器,拉黑后会触发 onBlackListAdded 回调。
说明
1. 如果用户 A 与用户 B 之间存在好友关系,拉黑后会解除双向好友关系,二者之间无法发起会话、无法发起加好友请求。
2. 如果您希望在拉黑后,仍然保留用户之间的好友关系,可以登录控制台编辑 Block configuration,配置路径:Applications > Your App > Chat > Configuration > Friends and Relationship Chains > Block configuration
被拉黑的用户默认不会感知到 “被拉黑” 的状态,消息发送后不会返回已被对方拉黑的错误码。 如果您希望被拉黑的用户在发消息时返回 “已被对方拉黑” 的错误提示,可以登录控制台关闭Blocklist Check。关闭后,被拉黑的用户在发送消息时,SDK 会报 20007 错误码。配置路径为:Applications > Your App > Chat > Configuration > Login and Message > Blocklist Check
示例代码如下:
Java
Swift
Objective-C
C++
List<String> userIDList = new ArrayList<>();
userIDList.add("user1");
userIDList.add("user2");
V2TIMManager.getFriendshipManager().addToBlackList(userIDList, new V2TIMValueCallback<List<V2TIMFriendOperationResult>>() {
@Override
public void onSuccess(List<V2TIMFriendOperationResult> v2TIMFriendOperationResults) {
// 拉黑成功
}

@Override
public void onError(int code, String desc) {
// 拉黑失败
}
});

// 监听黑名单列表新增通知
V2TIMManager.getFriendshipManager().addFriendListener(new V2TIMFriendshipListener() {
@Override
public void onBlackListAdd(List<V2TIMFriendInfo> infoList) {
// 黑名单列表新增通知
}
});
V2TIMManager.shared.addToBlackList(userIDList: ["user1", "user2"]) { resultList in
print( "addToBlackList succ")
} fail: { code, desc in
print( "addToBlackList fail, \\(code), \\(desc)")
}
V2TIMManager.shared.addFriendListener(listener: self)

func onBlackListAdded(infoList: Array<V2TIMFriendInfo>) {
print( infoList)
}
// 拉黑某人
[[V2TIMManager sharedInstance] addToBlackList:@[@"user1", @"user2"] succ:^(NSArray<V2TIMFriendOperationResult *> *resultList) {
// 拉黑成功
} fail:^(int code, NSString *desc) {
// 拉黑失败
}];

// 监听黑名单列表新增通知
[[V2TIMManager sharedInstance] addFriendListener:self];
- (void)onBlackListAdded:(NSArray<V2TIMFriendInfo *>*)infoList {
// 黑名单列表新增通知
}
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

V2TIMStringVector userIDList;
userIDList.PushBack(u8"user1");
userIDList.PushBack(u8"user2");

auto callback = new ValueCallback<V2TIMFriendOperationResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResultVector& friendOperationResultList) {
// 拉黑成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 拉黑失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->AddToBlackList(userIDList, callback);

// 监听黑名单列表新增通知
class FriendshipListener final : public V2TIMFriendshipListener {
public:
void OnBlackListAdded(const V2TIMFriendInfoVector& infoList) override {
// 黑名单列表新增通知
}
// 其他成员 ...
};
// 添加关系链事件监听器,注意在移除监听器之前需要保持 friendshipListener 的生命期,以免接收不到事件回调
FriendshipListener friendshipListener;
V2TIMManager::GetInstance()->GetFriendshipManager()->AddFriendListener(&friendshipListener);

解除拉黑

您可以调用 deleteFromBlackList (Java / Swift / Objective-C / C++) 将某用户从黑名单中移除,移除后可正常发起加好友请求、发起会话。 如果您事先调用 addFriendListener 添加了监听器,解除拉黑后会触发 onBlackListDeleted 回调。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> userIDList = new ArrayList<>();
userIDList.add("user1");
userIDList.add("user2");
V2TIMManager.getFriendshipManager().deleteFromBlackList(userIDList, new V2TIMValueCallback<List<V2TIMFriendOperationResult>>() {
@Override
public void onSuccess(List<V2TIMFriendOperationResult> v2TIMFriendOperationResults) {
// 解除拉黑成功
}

@Override
public void onError(int code, String desc) {
// 解除拉黑失败
}
});

// 监听黑名单列表删除通知
V2TIMManager.getFriendshipManager().addFriendListener(new V2TIMFriendshipListener() {
@Override
public void onBlackListDeleted(List<String> userList) {
// 黑名单列表删除通知
}
});
// 解除拉黑
V2TIMManager.shared.deleteFromBlackList(userIDList: ["user1"]) { resultList in
print( "deleteFromBlackList succ")
} fail: { code, desc in
print( "deleteFromBlackList fail, \\(code), \\(desc)")
}
V2TIMManager.shared.addFriendListener(listener: self)
func onBlackListDeleted(userIDList: Array<String>) {
print( userIDList)
}
// 解除拉黑
[[V2TIMManager sharedInstance] deleteFromBlackList:@[@"user1", @"user2"] succ:^(NSArray<V2TIMFriendOperationResult *> *resultList) {
// 解除拉黑成功
} fail:^(int code, NSString *desc) {
// 解除拉黑失败
}];

// 监听黑名单列表删除通知
[[V2TIMManager sharedInstance] addFriendListener:self];
- (void)onBlackListDeleted:(NSArray*)userIDList {
// 黑名单列表删除通知
}

template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

V2TIMStringVector userIDList;
userIDList.PushBack(u8"user1");
userIDList.PushBack(u8"user2");

auto callback = new ValueCallback<V2TIMFriendOperationResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResultVector& friendOperationResultList) {
// 解除拉黑成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 解除拉黑失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->DeleteFromBlackList(userIDList, callback);

// 监听黑名单列表删除通知
class FriendshipListener final : public V2TIMFriendshipListener {
public:
void OnBlackListAdded(const V2TIMFriendInfoVector& infoList) override {
// 黑名单列表删除通知
}
// 其他成员 ...
};
// 添加关系链事件监听器,注意在移除监听器之前需要保持 friendshipListener 的生命期,以免接收不到事件回调
FriendshipListener friendshipListener;
V2TIMManager::GetInstance()->GetFriendshipManager()->AddFriendListener(&friendshipListener);

获取黑名单列表

您可以通过 getBlackList (Java / Swift / Objective-C / C++) 查看已拉黑多少用户,并对黑名单人员进行管理。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMManager.getFriendshipManager().getBlackList(new V2TIMValueCallback<List<V2TIMFriendInfo>>() {
@Override
public void onSuccess(List<V2TIMFriendInfo> v2TIMFriendInfos) {
// 获取黑名单列表成功
}

@Override
public void onError(int code, String desc) {
// 获取黑名单列表失败
}
});
V2TIMManager.shared.getBlackList { infoList in
infoList.forEach { item in
// V2TIMFriendInfo
print( item.description)
}
} fail: { code, desc in
print( "getBlackList fail, \\(code), \\(desc)")
}
// 获取黑名单列表
[[V2TIMManager sharedInstance] getBlackList:^(NSArray<V2TIMFriendInfo *> *infoList) {
// 获取黑名单列表成功
} fail:^(int code, NSString *desc) {
// 获取黑名单列表失败
}];
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
using SuccessCallback = std::function<void(const T&)>;
using ErrorCallback = std::function<void(int, const V2TIMString&)>;

ValueCallback() = default;
~ValueCallback() override = default;

void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
success_callback_ = std::move(success_callback);
error_callback_ = std::move(error_callback);
}

void OnSuccess(const T& value) override {
if (success_callback_) {
success_callback_(value);
}
}
void OnError(int error_code, const V2TIMString& error_message) override {
if (error_callback_) {
error_callback_(error_code, error_message);
}
}

private:
SuccessCallback success_callback_;
ErrorCallback error_callback_;
};

auto callback = new ValueCallback<V2TIMFriendInfoVector>{};
callback->SetCallback(
[=](const V2TIMFriendInfoVector& friendInfoList) {
// 获取黑名单列表成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 获取黑名单列表失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->GetBlackList(callback);



帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈