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 blacklist
ZIMBlacklistQueryConfig config = new ZIMBlacklistQueryConfig();
// Fill in the number of user information to be obtained at one time
config.count = 100; 
// Fill in the pagination flag
config.nextFlag = 0;
zim.queryBlacklist(config, new ZIMBlacklistQueriedCallback() {
    @Override
        public void onBlacklistQueried(ArrayList<ZIMUserInfo> blacklist, int nextFlag,
                                    ZIMError zimError) {
        if(errorInfo.code == ZIMErrorCode.SUCCESS) {
            // Developers can get the blacklist from the blacklist.
        }
    }
});
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 ZIMBlacklistUsersAddedCallback.

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
ArrayList<String> userIDs = new ArrayList();
userIDs.add("zego");
zim.addUsersToBlacklist(userIDs, new ZIMBlacklistUsersAddedCallback() {
    @Override
    public void  onBlacklistUsersAdded(ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError error) {
        if(errorInfo.code == ZIMErrorCode.SUCCESS) {
            // errorUserList returns the information of users that failed to be added.
        }
    }
});
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 ZIMBlacklistUsersRemovedCallback .

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
ArrayList<String> userIDs = new ArrayList();
userIDs.add("zego");
zim.removeUsersFromBlacklist(userIDs, new ZIMBlacklistUsersRemovedCallback() {
    @Override
    public void  onBlacklistUsersRemoved(ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError error) {
        if(errorInfo.code == ZIMErrorCode.SUCCESS) {
            // errorUserList returns the information of users that failed to be removed.
        }
    }
});
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 ZIMBlacklistCheckedCallback.

Sample code
// Check if the user "zego" is in the blacklist
zim.checkUserIsInBlackList("zego", new ZIMBlacklistCheckedCallback(){
    @Override
    public void  onBlacklistChecked(boolean isUserInBlacklist, ZIMError zimError) {
        if(errorInfo.code == ZIMErrorCode.SUCCESS) {
                // isUserInBlacklist indicates whether the user is in the blacklist, true means in the blacklist, false means not in the blacklist
        }
    }
})
1
Copied!

Previous

Offline login

Next

Friend management