Block Users

Block users to prevent all communication with them. Use blockUsers() with an array of UIDs.

TypeScript
JavaScript

const usersList: String[] = ["UID1", "UID2", "UID3"];

CometChat.blockUsers(usersList).then(
(list: Object) => {
console.log("users list blocked", { list });
}, (error: CometChat.CometChatException) => {
console.log("Blocking user fails with error", error);
}
);

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

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

Alternatively, you can use the async/await syntax:

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

try {
  const list = await CometChat.blockUsers(usersList);
  console.log("users list blocked", { list });
} catch (error) {
  console.log("Blocking user fails with error", error);
}

Returns an object with UIDs as keys and "success" or "fail" as values. Each User in the request is processed independently.

Unblock Users

Unblock previously blocked users using unblockUsers() with an array of UIDs.

TypeScript
JavaScript

const usersList: String[] = ["UID1", "UID2", "UID3"];

CometChat.unblockUsers(usersList).then(
(list: Object) => {
console.log("users list blocked", { list });
}, (error: CometChat.CometChatException) => {
console.log("Blocking user fails with error", error);
}
);

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

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

Alternatively, you can use the async/await syntax:

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

try {
  const list = await CometChat.unblockUsers(usersList);
  console.log("users list unblocked", { list });
} catch (error) {
  console.log("unblocking user fails with error", error);
}

Returns an object with UIDs as keys and "success" or "fail" as values. Each User in the request is processed independently.

Get List of Blocked Users

Use BlockedUsersRequestBuilder to fetch blocked users with filtering and pagination.

Set Limit

Sets the number of blocked users to fetch per request.

TypeScript
JavaScript

let limit: number = 30;
let blockedUsersRequest: CometChat.BlockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
  .setLimit(limit)
  .build();

let limit = 30;
let blockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
                  				.setLimit(limit)
                  				.build();

Set Search Keyword

Filters blocked users by a search string.

TypeScript
JavaScript

let limit: number = 30;
let searchKeyword: string = "super";
let blockedUsersRequest: CometChat.BlockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
  .setLimit(limit)
  .setSearchKeyword(searchKeyword)
  .build();

let limit = 30;
let searchKeyword = "super";
let blockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
                  				.setLimit(limit)
                  				.setSearchKeyword(searchKeyword)
                  				.build();

Set Direction

Filters by block direction:

BLOCKED_BY_ME — Users blocked by the logged-in user
HAS_BLOCKED_ME — Users who have blocked the logged-in user
BOTH — Both directions (default)

TypeScript
JavaScript
JavaScript
JavaScript

let limit: number = 30;
let blockedUsersRequest: CometChat.BlockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
  .setLimit(limit)
  .setDirection(CometChat.BlockedUsersRequest.directions.BLOCKED_BY_ME)
  .build();

let limit = 30; let blockedUsersRequest = new

CometChat.BlockedUsersRequestBuilder() .setLimit(limit)
.setDirection(CometChat.BlockedUsersRequest.directions.BLOCKED_BY_ME)
.build(); ```
</Tab>

</Tabs>

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`](/sdk/reference/entities#user) objects containing n number of blocked users where N is the limit set in the builder class.

<Tabs>
<Tab title="TypeScript">
```typescript
let limit = 30;
let blockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
.setLimit(limit)
.setDirection(CometChat.BlockedUsersRequest.directions.BLOCKED_BY_ME)
.build();

let limit = 30; let blockedUsersRequest = new

CometChat.BlockedUsersRequestBuilder() .setLimit(limit)
.setDirection(CometChat.BlockedUsersRequest.directions.BLOCKED_BY_ME)
.build(); ```
</Tab>

</Tabs>

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

<Tabs>
<Tab title="TypeScript">
```typescript
let limit: number = 30;
let blockedUsersRequest: CometChat.BlockedUsersRequest = new CometChat.BlockedUsersRequestBuilder()
.setLimit(limit)
.build();

blockedUsersRequest.fetchNext().then(
(userList: CometChat.User[]) => {
console.log("Blocked user list received:", userList);
}, (error: CometChat.CometChatException) => {
console.log("Blocked user list fetching failed with error:", error);
}
);

const limit = 30;
const 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);
}
);

The fetchNext() method returns an array of User objects representing blocked users. Relevant fields to access on returned users:

Field	Getter	Return Type	Description
blockedByMe	`getBlockedByMe()`	`boolean`	Whether the logged-in user has blocked this user
hasBlockedMe	`getHasBlockedMe()`	`boolean`	Whether this user has blocked the logged-in user

Next Steps

Retrieve Users

Fetch and filter user lists

User Presence

Track online/offline status of users

User Management

Create, update, and delete users

Flag Message

Report inappropriate messages from users

​Block Users

​Unblock Users

​Get List of Blocked Users

​Set Limit

​Set Search Keyword

​Set Direction

​Next Steps