• UIKit
  • SDK
  • サーバー API
Chat/
SDK/
Web/
ユーザープロファイルとリレーションシップチェーン/
SDK
  • Chat SDK のインストール
  • Chat SDK の初期化
  • ログインとログアウト
  • 顧客インターフェース
  • Changelog
  • メッセージ
    • Overview
    • メッセージ送信
    • メッセージの受信
    • 過去のメッセージ
    • メッセージ転送
    • メッセージの変更
    • メッセージ削除
    • 過去のメッセージをクリアします
    • メッセージの取り消し
    • オンラインメッセージの送信
    • メッセージの既読レシート
    • クエリーメッセージ
    • ターゲットグループメッセージ
    • 通知しません
    • Key-Value の拡張
    • 翻訳
  • セッション
    • Overview
    • セッションリスト
    • セッションの取得
    • 未読数
    • セッションの先頭固定表示
    • セッションの削除
    • マーク
    • セッショングループ
  • グループ
    • Overview
    • グループ管理
    • グループプロファイル
    • グループメンバーの管理
    • グループメンバープロファイル
    • グループプロパティのカスタマイズ
    • グループカウンター
  • コミュニティトピック
    • コミュニティ管理
  • ユーザープロファイルとリレーションシップチェーン
    • ユーザープロファイル
    • ユーザー状態
    • 友達管理
    • 友達リスト
    • ブラックリスト
  • Guideline for Beginners
  • コンソールガイド
    • アプリケーションの作成とアップグレード
    • 基本設定
    • 機能設定
    • アカウント管理
    • グループ管理
    • コールバック設定
  • 製品紹介
    • メッセージ管理
      • シングルチャットメッセージ
      • メッセージの保存
      • オフラインプッシュ
      • グループメッセージ
      • メッセージフォーマット
    • アカウントシステム
      • ログイン認証
      • オンライン状態管理
    • グループ関連
      • グループシステム
      • グループ管理
    • ユーザープロファイルとリレーションシップチェーン
      • 資料管理
      • リレーションシップチェーン管理
  • 購入ガイド
    • 課金の概要
    • 価格
  • エラーコード
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

ブラックリスト

Feature Description

To block a user's messages, add the user to the blocklist.

Blocking a user

By adding a user to the blocklist, you can block all the messages sent by the user. Therefore, this API can be used to block the messages of a specified user.
If user A and user B are friends, the two-way friend relationship is terminated when either A or B is blocked by the other user.
If either user A or user B is blocked by the other user, neither user A nor user B can start a conversation with the other user.
If either user A or user B is blocked by the other user, neither user A nor user B can send a friend request to the other user.
API
chat.addToBlacklist(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
userIDList
Array
List of userID values of the users to be added to the blocklist. The number of userID values cannot exceed 1,000 per request.
Returned value
Promise
Sample
let promise = chat.addToBlacklist({userIDList: ['user1', 'user2']});
promise.then(function(imResponse) {
console.log(imResponse.data);
console.warn('addToBlacklist error:', imError); // Failed to add the user to the blocklist
});

Unblocking a user

After a user is removed from the blocklist, messages from the user can be received.
API
chat.removeFromBlacklist(options);
Parameter
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
userIDList
Array
List of userID values of the users to be removed from the blocklist. The number of userID values cannot exceed 1,000 per request.
Returned value
Promise
Sample
let promise = chat.removeFromBlacklist({userIDList: ['user1', 'user2']});
console.log(imResponse.data);
console.warn('removeFromBlacklist error:', imError); // Failed to remove the user from the blocklist
});

Getting the blocklist

The blocklist cached in the SDK can be obtained. When a friend list is updated, the SDK will deliver the TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED event.
API
chat.getBlacklist();
Returned value
Promise
Sample
let promise = chat.getBlacklist();
promise.then(function(imResponse) {
console.log(imResponse.data);
}).catch(function(imError) {
console.warn('getBlacklist error:', imError); // Failed to obtain the blocklist
});

Notification of a change in the blocklist

Sample
let onBlacklistUpdated = function(event) {
console.log(event.data);
};
chat.on(TencentCloudChat.EVENT.BLACKLIST_UPDATED, onBlacklistUpdated);