Block Users

Block or unblock users in your Android app so all messages to and from them stop, and fetch the list of everyone you have blocked.

​

Block Users

In other words, as a logged-in user, how do I block a user from sending me messages?

You can block users using the blockUsers() method. Once any user is blocked, all the communication to and from the respective user will be completely blocked. You can block multiple users in a single operation. The blockUsers() method takes a List<String> as a parameter which holds the list of UIDs to be blocked.

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 if the block operation for the UID was successful or not.

​

Unblock Users

In other words, as a logged-in user, how do I unblock a user I previously blocked?

You can unblock the already blocked users using the unblockUsers() method. You can unblock multiple users in a single operation. The unblockUsers() method takes a List<String> as a parameter which holds the list of UIDs to be unblocked.

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 if the unblock operation for the UID was successful or not.

​

Get list of blocked users

In other words, as a logged-in user, how do I get a list of all users I’ve blocked?

In order to fetch the list of blocked users, you can use the BlockedUsersRequest class. To use this class i.e to create an object of the BlockedUsersRequest class, you need to use the BlockedUsersRequestBuilder class. The BlockedUsersRequestBuilder class allows you to set the parameters based on which the blocked users are to be fetched.

The BlockedUsersRequestBuilder class allows you to set the below parameters:

​

Set Limit

This method sets the limit i.e. the number of blocked users that should be fetched in a single iteration.

Java

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

Kotlin

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

​

Set Search Keyword

With offline support on, this filter is answered by the server only; the cached page is empty.

This method allows you to set the search string based on which the blocked users are to be fetched.

Java

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

Kotlin

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

​

Set Direction

• CometChat.BlockedUsersRequest.DIRECTION.BLOCKED_BY_ME - This will ensure that the list of blocked users only contains the users blocked by the logged in user.
• CometChat.BlockedUsersRequest.DIRECTION.HAS_BLOCKED_ME - This will ensure that the list of blocked users only contains the users that have blocked the logged in user.
• CometChat.BlockedUsersRequest.DIRECTION.BOTH - This will make sure the list of users includes both 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()    

Finally, once all the parameters are set in the builder class, you need to call the build() method to get the object of the BlockedUsersRequest class.

Once you have the object of the BlockedUsersRequest class, you need to call the fetchNext() method. Calling this method will return a list of User objects containing n number of blocked users where N is the limit set in the builder class.

Starting with v5.1.0, the CallbackListener overload of `fetchNext()` is deprecated. Use `UserFetchListener` instead; it requires SDK 5.1.0 or later, so on 5.0.x keep using CallbackListener. With offline support off, it behaves exactly like the old callback: onError is unchanged, and the server result arrives in the onServer… callback instead of onSuccess. With offline support on, it also delivers the cached result first; the old overload keeps working but receives only the server result. See Show Cached Data.

Java

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

blockedUsersRequest.fetchNext(new CometChat.UserFetchListener() {
@Override
public void onCachedUsers(List<User> users) {
  // Cached page: fires first (even when empty). Render immediately.
  for (User user : users) {
    Log.e(TAG, user.getUid());
  }
}

@Override
public void onServerUsers(List<User> users) {
  // Server page: reconcile your displayed list, keyed by uid.
  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 : CometChat.UserFetchListener() {
override fun onCachedUsers(users: List<User>) {
  // Cached page: fires first (even when empty). Render immediately.
  for (user in users) {
    Log.e(TAG, user.uid)
  }
}

override fun onServerUsers(users: List<User>) {
  // Server page: reconcile your displayed list, keyed by uid.
  for (user in users) {
    Log.e(TAG, user.uid)
  }
}

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

​

Offline Behaviour

With offline support enabled, BlockedUsersRequest.fetchNext() on a UserFetchListener first delivers onCachedUsers from the SDK’s own blocked-users list, which it refreshes on login and on reconnect and updates when you call blockUsers() or unblockUsers(). Then onServerUsers delivers the live page to reconcile by uid; the server page is not saved to the device. The cached page is empty when no users are blocked or when setSearchKeyword is set. Offline, the read ends with onError with code ERROR_INTERNET_UNAVAILABLE after the cached page. See Show Cached Data.

Builder method	Offline
setLimit	Cached
setDirection	Cached
setSearchKeyword	Server only — cached page is empty