Ban/Unban a List of Channel Members

When a user is banned in a channel, they are removed from a channel and no longer able to participate or observe messages in that channel.

Moderators can ban and unban users. When a user is banned in a channel, they are forcibly removed from the channel and may no longer participate or observe messages in that channel. All their previous messages in the channel will also be automatically deleted.

A user that has been banned from a channel can not rejoin the channel until they have been unbanned.

Global Ban

As well as the banning and unbanning of users, admins also have the ability to global ban a user. When a user is globally banned, they can no longer access Amity's network and will be forcibly removed from all their existing channels. All the globally banned user's messages will also be deleted.

The globally banned user can not access Amity's network again until they have been globally unbanned.

When a user is banned, it can take up to 30 seconds before the user is disconnected from the network.

Ban Users

Banning members is a more heavy-handed moderation method. When a user is banned, all its messages are retroactively deleted, it will be removed from the channel, and it will not be allowed to join the channel again until he is explicitly unbanned.

iOS

let moderation = AmityChannelModeration(client: <amityclient>, channel: <channel-id>)
​
moderation.banMembers(["user1"]) { success, errror in
  ...
}

Android

JavaScript

repository.banMembers({
  userIds: ['user1'],
}).catch(error => {
  ...
});

TypeScript

Version 6

Beta (v0.0.1)

Flutter

Unban Users

iOS

Supported ✅ (please wait while we prepare a real example!)

Android

JavaScript

repository.unbanMembers({
  userIds: ['user1'],
}).catch(error => {
  ...
});

TypeScript

Version 6

Beta (v0.0.1)

Flutter

This feature does not work with Broadcast and Conversation channels. Calling banMembers() or unbanMembers() on these channels will result in an error.