Block Users

Block and unblock users to control communication in your Android app

AI Integration Quick Reference

Kotlin

// Block users
val uids = listOf("UID1", "UID2", "UID3")
CometChat.blockUsers(uids, object : CometChat.CallbackListener<HashMap<String, String>>() {
    override fun onSuccess(resultMap: HashMap<String, String>) {
        // resultMap contains UID -> "success"/"fail"
    }
    override fun onError(e: CometChatException) { }
})

// Unblock users
CometChat.unblockUsers(uids, object : CometChat.CallbackListener<HashMap<String, String>>() {
    override fun onSuccess(resultMap: HashMap<String, String>) { }
    override fun onError(e: CometChatException) { }
})

// Get blocked users list
val request = BlockedUsersRequestBuilder()
    .setLimit(30)
    .setDirection(BlockedUsersRequest.DIRECTION_BLOCKED_BY_ME)
    .build()
request.fetchNext(object : CallbackListener<List<User>>() {
    override fun onSuccess(users: List<User>) { }
    override fun onError(e: CometChatException) { }
})

Java

// Block users
List<String> uids = Arrays.asList("UID1", "UID2", "UID3");
CometChat.blockUsers(uids, new CometChat.CallbackListener<HashMap<String, String>>() {
    @Override
    public void onSuccess(HashMap<String, String> resultMap) {
        // resultMap contains UID -> "success"/"fail"
    }
    @Override
    public void onError(CometChatException e) { }
});

// Unblock users
CometChat.unblockUsers(uids, new CometChat.CallbackListener<HashMap<String, String>>() {
    @Override
    public void onSuccess(HashMap<String, String> resultMap) { }
    @Override
    public void onError(CometChatException e) { }
});

// Get blocked users list
BlockedUsersRequest request = new BlockedUsersRequest.BlockedUsersRequestBuilder()
    .setLimit(30)
    .setDirection(BlockedUsersRequest.DIRECTION_BLOCKED_BY_ME)
    .build();
request.fetchNext(new CometChat.CallbackListener<List<User>>() {
    @Override
    public void onSuccess(List<User> users) { }
    @Override
    public void onError(CometChatException e) { }
});

Block Users

Use blockUsers() to block one or more users. All communication to and from blocked users is stopped. Pass a List<String> of UIDs to block.

Java

List<String > uids = new ArrayList<>();
uids.add("UID1");
uids.add("UID2");
uids.add("UID3");
CometChat.blockUsers(uids, new CometChat.CallbackListener<HashMap<String, String>>() {
@Override
public void onSuccess(HashMap<String, String> resultMap) {
  // Handle block users success.
}

@Override
public void onError(CometChatException e) {
  // Handle block users failure
}
});

Kotlin

val uids = ArrayList<String>()
uids.add("UID1")
uids.add("UID2")
uids.add("UID3")

CometChat.blockUsers(uids,object:CometChat.CallbackListener<HashMap<String, String>>() {
override fun onSuccess(resultMap: HashMap<String, String>) {
  // Handle unblock users success.
}

override fun onError(e: CometChatException) {
  // Handle unblock users failure
}
})

In the onSuccess() callback, you receive a HashMap which contains UIDs as the keys and success or fail as the value based on whether the block operation for the UID was successful or not.

Unblock Users

Use unblockUsers() to unblock previously blocked users. Pass a List<String> of UIDs to unblock.

Java

List<String > uids = new ArrayList<>();
uids.add("UID1");
uids.add("UID2");
uids.add("UID3");
CometChat.unblockUsers(uids, new CometChat.CallbackListener<HashMap<String, String>>() {
@Override
public void onSuccess(HashMap<String, String> resultMap) {
  // Handle unblock users success.
}

@Override
public void onError(CometChatException e) {
  // Handle unblock users failure
}
});

Kotlin

val uids = ArrayList<String>()
uids.add("UID1")
uids.add("UID2")
uids.add("UID3")

CometChat.unblockUsers(uids,object:CometChat.CallbackListener<HashMap<String, String>>() {
override fun onSuccess(resultMap: HashMap<String, String>) {
  // Handle unblock users success.
}

override fun onError(e: CometChatException) {
  // Handle unblock users failure
}
})

In the onSuccess() callback, you receive a HashMap which contains UIDs as the keys and success or fail as the value based on whether the unblock operation for the UID was successful or not.

---

Get List of Blocked Users

Use BlockedUsersRequestBuilder to fetch blocked users with optional filters.

Set Limit

Set the number of blocked users to fetch per request.

Java

BlockedUsersRequest blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder()
.setLimit(10)
.build();

Kotlin

val blockedUsersRequest = BlockedUsersRequestBuilder()
.setLimit(10)
.build()

Set Search Keyword

Filter blocked users by a search string.

Java

BlockedUsersRequest blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder()
.setSearchKeyword("abc")
.build();

Kotlin

val blockedUsersRequest = BlockedUsersRequestBuilder()
.setSearchKeyword("abc")
.build()

Set Direction

• BlockedUsersRequest.DIRECTION_BLOCKED_BY_ME - Ensures that the list of blocked users only contains users blocked by the logged-in user.
• BlockedUsersRequest.DIRECTION_HAS_BLOCKED_ME - Ensures that the list of blocked users only contains users that have blocked the logged-in user.
• BlockedUsersRequest.DIRECTION_BOTH - Ensures the list of users includes both of the above cases. This is the default value for the direction variable if it is not set.

Java

BlockedUsersRequest blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder()
.setDirection(BlockedUsersRequest.DIRECTION_BLOCKED_BY_ME)
.build();

Kotlin

val blockedUsersRequest = BlockedUsersRequestBuilder()
.setDirection(BlockedUsersRequest.DIRECTION_BLOCKED_BY_ME)
.build()    

Fetch Blocked Users

After configuring the builder, call build() then fetchNext() to retrieve blocked users.

Java

BlockedUsersRequest blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder().setLimit(10).build();

blockedUsersRequest.fetchNext(new CometChat.CallbackListener<List<User>>() {
@Override
public void onSuccess(List<User> users) {
  for(User user : users){
    Log.e(TAG, user.getUid());
  }
}

@Override
public void onError(CometChatException e) {
  Log.e(TAG, e.getMessage());
}
});

Kotlin

val blockedUsersRequest = BlockedUsersRequestBuilder().setLimit(10).build()

blockedUsersRequest.fetchNext(object : CallbackListener<List<User>>() {
override fun onSuccess(users: List<User>) {
  for (user in users) {
    Log.e(TAG, user.uid)
  }
}

override fun onError(e: CometChatException) {
  Log.e(TAG, e.message)
}
})

---

Next Steps

Retrieve Users

Fetch and filter user lists in your app

User Management

Learn about user objects and properties

Send Message

Send messages to users and groups

User Presence

Track user online/offline status