Block Users

AI Integration Quick Reference

// Block users
CometChat.blockUsers(["UID1", "UID2"],
    onSuccess: { print("Blocked") }, onError: { error in })

// Unblock users
CometChat.unblockUsers(["UID1", "UID2"],
    onSuccess: { users in }, onError: { error in })

// Get blocked users list
let request = BlockedUserRequest.BlockedUserRequestBuilder.set(limit: 30).build()
request.fetchNext(onSuccess: { users in }, onError: { error in })

Directions: .byMe | .me | .both (default)

Blocking a user prevents all communication between them and the logged-in user — messages, calls, and presence updates are all suppressed. You can block and unblock users by UID, and fetch the blocked users list with filtering and pagination.

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

Swift
Objective C

let blockUsers = ["UID1", "UID2", "UID3"]

CometChat.blockUsers(blockUsers, onSuccess: {
                
   print("Blocked user successfully.")
                
}, onError: { (error) in
                
   print("Blocked user failed with error: \\(error?.errorDescription)")
                
})

NSMutableArray *users = [NSMutableArray alloc]init];
[users addObject:@"UID1"];
[users addObject:@"UID2"];
[users addObject:@"UID3"];

[CometChat blockUsers: users onSuccess:^ (NSDictionary *dict) {

  NSLog(@"Blocked user successfully.");
  
}, onError:^ (CometChatException *error){

  NSLog(@"Blocked user failed with error: %@", error.errorDescription);
}];

Returns a dictionary with UIDs as keys and "success" or "fail" as values based on if the block operation for each UID was successful.

Unblock Users

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

Swift
Objective C

let unblockUsers = ["UID1", "UID2", "UID3"]

CometChat.unblockUsers(unblockUsers, onSuccess: { (users) in
                
   print("Unblocked user successfully.")
                
}, onError: { (error) in
                
   print("Unblocked user failed with error: \\(error?.errorDescription)")
                
})

NSMutableArray *users = [NSMutableArray alloc]init];
[users addObject:@"UID1"];
[users addObject:@"UID2"];
[users addObject:@"UID3"];

[CometChat unblockUsers: users onSuccess:^ (NSDictionary *dict){

  NSLog(@"unblocked user successfully.");
  
}, onError:^ (CometChatException *error){

  NSLog(@"unblocked user failed with error : %@", error.errorDescription);
}];

Returns a dictionary with UIDs as keys and "success" or "fail" as values based on if the unblock operation for each UID was successful.

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.

Swift

let blockedUserRequest = BlockedUserRequest.BlockedUserRequestBuilder.set(limit: 20).build();

Set Search Keyword

Filters blocked users by a search string.

Swift

let blockedUserRequest = BlockedUserRequest.BlockedUserRequestBuilder
.set(searchKeyword: "abc")
.set(limit: 20)
.build();

Set Direction

Filters by block direction:

.byMe — Users blocked by the logged-in user
.me — Users who have blocked the logged-in user
.both — Both directions (default)

Swift

let blockedUserRequest = BlockedUserRequest.BlockedUserRequestBuilder
.set(searchKeyword: "abc")
.set(limit: 20)
.set(direction: .both)
.build();

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

Swift
Objective C

let blockedUserRequest = BlockedUserRequest.BlockedUserRequestBuilder(limit: 20).build();

blockedUserRequest.fetchNext(onSuccess : { (users) in
            
   print("Blocked users: \\(users)")
            
}, onError : { (error) in
            
   print("Error while fetching the blocked user request:  \\(error?.errorDescription)")

})

BlockedUserRequest *blockedUserRequest = [[[BlockedUserRequestBuilder alloc]initWithLimit:2] build];

[blockedUserRequest fetchNextOnSuccess: ^(NSArray<User *> * users){

  NSLog(@"Blocked user list fetched successfully.")
  
} onError:^ (CometChatException *error){

  NSLog(@"Fetching block user list failed with error: %@", error.errorDescription);
  
}];

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

Field	Type	Description
blockedByMe	Bool	Whether the logged-in user has blocked this user
hasBlockedMe	Bool	Whether this user has blocked the logged-in user

Offline support

With offline support enabled (SDK 4.2.0 or later), fetchNext on a BlockedUserRequest has an overload that first delivers onCachedUsers from the SDK’s own blocked-users list. The SDK refreshes that list on login and on each catch-up sync, and updates it when you call blockUsers or unblockUsers. The first cached page holds the whole list and later pages are empty. Then onServerUsers delivers the live page to reconcile by uid. The cached page is empty when no users are blocked or when set(searchKeyword:) is set. Offline, the read ends with onError, code ERROR_INTERNET_UNAVAILABLE, after the cached page. Blocking and unblocking need a connection and are not queued. See Show Cached Data.

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

​Offline support

​Next Steps