logo
In-app Chat
SDK Error Codes
Powered Byspreading
On this page

Blacklist management


Note

Blacklisting and friend operations do not affect each other. Taking user A and B as friends as an example:

  1. User A can blacklist user B, but they will still be friends.
  2. If at this point, user A and user B end their friendship, user B will still be on user A's blacklist.
  3. Afterwards, if user A removes user B from the blacklist, user B will still not be user A's friend.

Function Introduction

You can check your blacklist, blacklist a specified user (no longer receiving messages from that user), move out of the blacklist, and check if a specified user is in the blacklist.

Implementation Process

Query Blacklist

After logging in to the ZIM SDK, users can query the blacklist by using the queryBlacklist interface.

The query result is returned through the ZIMBlacklistQueriedCallback.

Sample code
// Query the blacklist
ZIMBlacklistQueryConfig config = ZIMBlacklistQueryConfig();
// Fill in the number of user information obtained at one time
config.count = 100;
// Fill in the paging pull flag
config.nextFlag = 0;
ZIM zim = ZIM.getInstance()!;
zim.queryBlacklist(config).then((ZIMBlacklistQueriedResult result) => {
    // Developers can get the blacklist from result.blacklist.
}).catchError((onError){
    // Handle according to the SDK error code document
});
1
Copied!

Block Users

After logging in to the ZIM SDK, users can call the addUsersToBlacklist interface to add specified users to the blacklist.

The result of blocking users is returned through the ZIMBlacklistUsersAddedResult.

Warning
  • Up to 20 users can be blocked with one API call. Exceeding the limit will cause the API call to fail.
  • The default maximum number of blacklisted users is 1000. If you need to increase it, please contact ZEGOCLOUD technical support.
Sample code
// Add user "zego" to the blacklist
try{
    ZIMBlacklistUsersAddedResult result = await ZIM.getInstance()!.addUsersToBlacklist(['zego']);
    // result.errorUserList returns the information of users that failed to be added.
} on PlatformException catch (onError){
    // Handle according to the SDK error code document
}
1
Copied!

Unblock Users

After logging in to the ZIM SDK, users can call the removeUsersFromBlacklist interface to remove specified users from the blacklist.

The unblock operation will be returned through the ZIMBlacklistUsersRemovedResult .

Warning

Up to 20 users can be removed with one API call. Exceeding the limit will cause the API call to fail.

Sample code
// Remove user "zego" from the blacklist
try{
    ZIMBlacklistUsersRemovedResult result = await ZIM.getInstance()!.removeUsersFromBlacklist(["zego"]);
    // result.errorUserList returns the information of users that failed to be added.
} on PlatformException catch (onError){
    // Handle according to the SDK error code document
}
1
Copied!

Check if the user is in the blacklist

After logging in to the ZIM SDK, users can call the checkUserIsInBlacklist interface to check if a specified user is in their blacklist.

The result of the check operation is returned through the ZIMBlacklistCheckedResult.

Sample code
// Check if user "zego" is in the blacklist
try{
    ZIMBlacklistCheckedResult result = await ZIM.getInstance()!.checkUserIsInBlacklist("zego");
    // result.isUserInBlacklist indicates whether the user is in the blacklist. true means in the blacklist, false means not in the blacklist
} on PlatformException catch (onError){
    // Handle according to the SDK error code document
}
1
Copied!

Previous

Offline login

Next

Friend management