CometChat Pro Documentation

You'll find comprehensive guides and documentation to help you start working with CometChat as quickly as possible. Let's jump right in!

Block Users

Learn how to block users from sending messages to the logged-in user.

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 Array as a parameter which holds the list of UID's to be blocked.

var usersList = ["UID1", "UID2", "UID3"];
CometChat.blockUsers(usersList).then(
  list => {
    console.log("users list blocked", { list });
  },
  error => {
    console.log("Blocking user fails with error", error);
  }
);

It returns a Array which contains UID's 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 Array as a parameter which holds the list of UID's to be unblocked.

var usersList = ["UID1", "UID2", "UID3"];

CometChat.unblockUsers(usersList).then(
  list => {
    console.log("users list unblocked", { list });
  },
  error => {
    console.log("unblocking user fails with error", error);
  }
);

It returns a Array which contains UID's 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:

  1. setLimit(limit: number) - This method sets the limit i.e. the number of blocked users that should be fetched in a single iteration.
var blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder()
  .setLimit(10)
  .build();
  1. setSearchKeyword(searchString: string) - This method allows you to set the search string based on which the blocked users are to be fetched.
var blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder()
  .setSearchKeyword("abc")
  .build();
  1. setDirection(direction: string) - This can hold one of the below values:
    a. 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.
    b. CometChat.BlockedUsersRequest.DIRECTION.HAS_BLOCKED_ME - setting the direction to this will return only the list of users that have blocked the logged in user.
    c. 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.
var blockedUsersRequest = new BlockedUsersRequest.BlockedUsersRequestBuilder()
  .setDirection(CometChat.BlockedUsersRequest.DIRECTION.BLOCKED_BY_ME)
  .build();

Finally, once all the parameters are set to 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.

var limit = 30;
var blockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
  .setLimit(limit)
  .build();
blockedUsersRequest.fetchNext().then(
  userList => {
    console.log("Blocked user list received:", userList);
  },
  error => {
    console.log("Blocked user list fetching failed with error:", error);
  }
);

Updated about a year ago


Block Users


Learn how to block users from sending messages to the logged-in user.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.