Community Moderation

Use community moderation APIs for role assignment, ban management, and permission checks. Role IDs must already exist in your network; these APIs assign or remove roles from users, but they do not create roles.

Parameters

Operation	Parameter	Required	Description
Add roles	`communityId`	Yes	Community ID where roles should be assigned.
Add roles	`roleIds` / `roles`	Yes	Existing role IDs to assign. Flutter accepts one role ID per call.
Add roles	`userIds`	Yes	User IDs that should receive the roles.
Remove roles	`communityId`	Yes	Community ID where roles should be removed.
Remove roles	`roleIds` / `roles`	Yes	Existing role IDs to remove. Flutter accepts one role ID per call.
Remove roles	`userIds`	Yes	User IDs whose roles should be updated.
Ban or unban members	`communityId`	Yes	Community ID whose ban list should change.
Ban or unban members	`userIds`	Yes	User IDs to ban or unban.
Check permissions	`permission`	Yes	Permission value to check, such as ban-community-user.
Check permissions	`communityId`	Yes	Community where the permission should be evaluated.

Role Management

TypeScript, iOS, and Android accept a list of role IDs. Flutter exposes addRole() and removeRole() for one role ID per call.

Add Roles

Add role IDs to one or more users after the roles already exist in your network.

let communityModeration = AmityCommunityModeration(communityId: communityId)

do {
    try await communityModeration.addRoles(
        ["community-moderator"],
        userIds: ["user1", "user2"]
    )
} catch let error {
    handleError(error)
}

fun addRoles(communityRepository: AmityCommunityRepository) {
    communityRepository
        .moderation(communityId = "communityId")
        .addRoles(
            roles = listOf("community-moderator"),
            userIds = listOf("user1", "user2")
        )
        .doOnComplete {
            // Roles added
        }
        .subscribe()
}

import { CommunityRepository } from '@amityco/ts-sdk';

async function addRoles(
  communityId: Amity.Community['communityId'],
  roleIds: Amity.Role['roleId'][],
  userIds: Amity.User['userId'][],
): Promise<boolean> {
  return CommunityRepository.Moderation.addRoles(communityId, roleIds, userIds);
}

Future<void> addRole(String communityId, List<String> userIds) async {
  await AmitySocialClient.newCommunityRepository()
      .moderation(communityId)
      .addRole('community-moderator', userIds);
}

Remove Roles

Remove role IDs from one or more users when they should no longer have that community role.

let communityModeration = AmityCommunityModeration(communityId: communityId)

do {
    try await communityModeration.removeRoles(
        ["community-moderator"],
        userIds: ["user1", "user2"]
    )
} catch let error {
    handleError(error)
}

fun removeRoles(communityRepository: AmityCommunityRepository) {
    communityRepository
        .moderation(communityId = "communityId")
        .removeRoles(
            roles = listOf("community-moderator"),
            userIds = listOf("user1", "user2")
        )
        .doOnComplete {
            // Roles removed
        }
        .subscribe()
}

import { CommunityRepository } from '@amityco/ts-sdk';

async function removeRoles(
  communityId: Amity.Community['communityId'],
  roleIds: Amity.Role['roleId'][],
  userIds: Amity.User['userId'][],
): Promise<boolean> {
  return CommunityRepository.Moderation.removeRoles(communityId, roleIds, userIds);
}

Future<void> removeRole(String communityId, List<String> userIds) async {
  await AmitySocialClient.newCommunityRepository()
      .moderation(communityId)
      .removeRole('community-moderator', userIds);
}

Ban Members

Use banMembers() / banMember() to ban users from a community.

let communityModeration = AmityCommunityModeration(communityId: communityId)

do {
    try await communityModeration.banMembers(["user1", "user2"])
} catch let error {
    handleError(error)
}

fun banMembers(communityRepository: AmityCommunityRepository) {
    communityRepository
        .moderation(communityId = "communityId")
        .banMembers(userIds = listOf("user1", "user2"))
        .doOnComplete {
            // Members banned
        }
        .subscribe()
}

import { CommunityRepository } from '@amityco/ts-sdk';

async function banMembers(
  communityId: Amity.Community['communityId'],
  userIds: Amity.User['userId'][],
) {
  const { data: bannedMembers } =
    await CommunityRepository.Moderation.banMembers(communityId, userIds);

  return bannedMembers;
}

Future<void> banMembers(String communityId, List<String> userIds) async {
  await AmitySocialClient.newCommunityRepository()
      .moderation(communityId)
      .banMember(userIds);
}

Unban Members

Use unbanMembers() / unbanMember() to remove community bans.

let communityModeration = AmityCommunityModeration(communityId: communityId)

do {
    try await communityModeration.unbanMembers(["user1", "user2"])
} catch let error {
    handleError(error)
}

fun unbanMembers(communityRepository: AmityCommunityRepository) {
    communityRepository
        .moderation(communityId = "communityId")
        .unbanMembers(userIds = listOf("user1", "user2"))
        .doOnComplete {
            // Members unbanned
        }
        .subscribe()
}

import { CommunityRepository } from '@amityco/ts-sdk';

async function unbanMembers(
  communityId: Amity.Community['communityId'],
  userIds: Amity.User['userId'][],
) {
  const { data: unbannedMembers } =
    await CommunityRepository.Moderation.unbanMembers(communityId, userIds);

  return unbannedMembers;
}

Future<void> unbanMembers(String communityId, List<String> userIds) async {
  await AmitySocialClient.newCommunityRepository()
      .moderation(communityId)
      .unbanMember(userIds);
}

Check Permissions

Permission checks use the current user’s cached permission state. Query the relevant community/member state before relying on the result for UI decisions.

let canBan = await client.hasPermission(
    .banCommunityUser,
    forCommunity: communityId
)

fun checkCommunityPermission() {
    AmityCoreClient
        .hasPermission(permission = AmityPermission.BAN_COMMUNITY_USER)
        .atCommunity(communityId = "communityId")
        .check()
        .doOnNext { hasPermission: Boolean ->
            // Render permission-aware UI
        }
        .subscribe()
}

function checkCommunityPermission(communityId: Amity.Community['communityId']) {
  return client
    .hasPermission(Amity.Permission.BanChannelCommunityPermission)
    .community(communityId);
}

void checkCommunityPermission(String communityId) {
  final hasPermission = AmityCoreClient
      .hasPermission(AmityPermission.BAN_COMMUNITY_USER)
      .atCommunity(communityId)
      .check();
}

Member Management

Add and remove community members

Join / Leave Community

User-initiated joining, leaving, and approval workflows

Query Community Members

Search and filter community member lists

Community Invitation

Invitation-based member onboarding workflows

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Parameters

Role Management

Add Roles

Remove Roles

Ban Members

Unban Members

Check Permissions

Member Management

Join / Leave Community

Query Community Members

Community Invitation

​Parameters

​Role Management

​Add Roles

​Remove Roles

​Ban Members

​Unban Members

​Check Permissions

​Related Topics

Member Management

Join / Leave Community

Query Community Members

Community Invitation

Parameters

Role Management

Add Roles

Remove Roles

Ban Members

Unban Members

Check Permissions

Related Topics