please select
Docs Overview/
Chat/
SDK/
Flutter/
User/
Blocklist/

Blocklist

Feature Description

To block a user's messages, add the user to the blocklist.

Blocklist

Blocking a user

Call the addToBlackList API (Details) to add a user to the blocklist, that is, block the user.
By default, a blocked user does not know that he/she is "blocked". After the user sends a message, the error code indicating that he/she has been blocked will not be returned. To have the "You have been blocked by the user" error message returned after a blocked user sends a message, you can log in to the IM console, select Feature Configuration > Login and Message > Blocklist Check, and disable Show "Sent successfully" After Sending Messages. Then the SDK will report error code 20007 after a blocked user sends a message.
// Add a user to the blocklist
V2TimValueCallback<List<V2TimFriendOperationResult>> addBlackList = await friendshipManager.addToBlackList(userIDList: ['user1']);

Unblocking a user

Call deleteFromBlackList (Details) to remove a user from the blocklist, after which messages from the user can be received.

// Remove a user from the blocklist
V2TimValueCallback<List<V2TimFriendOperationResult>> deleteBlackList = await friendshipManager.deleteFromBlackList(userIDList: ['user1']);

Getting the blocklist

Call getBlackList (Details) to view how many users have been blocked and manage them.
// Get the blocklist
V2TimValueCallback<List<V2TimFriendInfo>> blacklist = await friendshipManager.getBlackList();