Message Flagging

Use message flagging when a signed-in user reports a chat message. The SDKs expose three client-side actions: flag a message, unflag a message, and check whether the current user has already flagged a fetched message. Flagged messages are sent to the moderation backend. Keep product policy, review workflow, and enforcement copy outside the SDK integration layer so this page stays focused on the calls your app makes.

Platform Surface

Platform	Flag with reason	Unflag	Check current user’s flag
TypeScript	`MessageRepository.flagMessage(messageId, reason)`	`MessageRepository.unflagMessage(messageId)`	`MessageRepository.isMessageFlaggedByMe(messageId)`
iOS	`messageRepository.flagMessage(withId:reason:)`	`messageRepository.unflagMessage(withId:)`	`messageRepository.isMessageFlaggedByMe(withId:)`
Android	`messageRepository.flagMessage(messageId, reason)`	`messageRepository.unflagMessage(messageId)`	`message.isFlaggedByMe()` on a fetched `AmityMessage`
Flutter	`messageRepository.flagMessage(messageId:reason:)` or `message.flagWithReason(reason)`	`messageRepository.unflag(messageId)` or `message.unflag()`	`message.isFlaggedByMe` on a fetched `AmityMessage`

The older Android no-reason flagMessage(messageId) overload and Flutter flag(messageId) repository method still exist for compatibility, but new docs should use reason-based flagging.

Parameters

Operation	Parameter	Required	Description
Flag	`messageId`	Yes	Message ID to report.
Flag	`reason`	Yes	Moderation reason enum or custom reason string, depending on platform.
Unflag	`messageId`	Yes	Message ID whose report should be removed for the current user.
Check flag state	`messageId`	Yes	Message ID to check through the repository where supported.
Check flag state	Fetched message object	Depends	Android and Flutter expose `isFlaggedByMe` on a fetched `AmityMessage`.

Flag A Message

Flag a message with a moderation reason so your product can route it into review.

import { ContentFlagReasonEnum, MessageRepository } from '@amityco/ts-sdk';

const flagged = await MessageRepository.flagMessage(
  messageId,
  ContentFlagReasonEnum.SpamOrScams,
);

renderResults(flagged);

try await messageRepository.flagMessage(
    withId: "message-id",
    reason: .spamOrScams
)

showSuccessMessage("Message flagged")

val disposable = messageRepository
    .flagMessage(
        messageId = messageId,
        reason = AmityContentFlagReason.SpamOrScams,
    )
    .subscribe(
        { showSuccessMessage() },
        { error -> handleFlagError(error) },
    )

final flaggedMessage = await AmityChatClient.newMessageRepository()
    .flagMessage(
      messageId: messageId,
      reason: AmityContentFlagReason.spamOrScams,
    );

final isFlaggedByMe = flaggedMessage.isFlaggedByMe;

Use A Custom Reason

Use the Others reason only when your UI collects additional detail from the reporter. Pass a custom reason string when the platform enum supports Others or direct string reasons.

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

const flagged = await MessageRepository.flagMessage(
  messageId,
  'Contains sensitive account information',
);

renderResults(flagged);

try await messageRepository.flagMessage(
    withId: "message-id",
    reason: .others("Contains sensitive account information")
)

val disposable = messageRepository
    .flagMessage(
        messageId = messageId,
        reason = AmityContentFlagReason.Others(
            "Contains sensitive account information",
        ),
    )
    .subscribe(
        { showSuccessMessage() },
        { error -> handleFlagError(error) },
    )

final flaggedMessage = await AmityChatClient.newMessageRepository()
    .flagMessage(
      messageId: messageId,
      reason: AmityContentFlagReason.others(
        'Contains sensitive account information',
      ),
    );

final flagCount = flaggedMessage.flagCount;

Unflag A Message

Remove the current user’s flag from a message when the user reverses the report action.

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

const unflagged = await MessageRepository.unflagMessage(messageId);

renderResults(unflagged);

try await messageRepository.unflagMessage(withId: "message-id")
showSuccessMessage("Message unflagged")

val disposable = messageRepository
    .unflagMessage(messageId = messageId)
    .subscribe(
        { showSuccessMessage() },
        { error -> handleUnflagError(error) },
    )

final unflaggedMessage = await AmityChatClient.newMessageRepository()
    .unflag(messageId);

final isFlaggedByMe = unflaggedMessage.isFlaggedByMe;

Check Flag State

TypeScript and iOS can ask the repository for the current user’s flag state by message ID. Android and Flutter expose the state on fetched message objects. Read flag state before rendering selected or disabled report controls.

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

const isFlaggedByMe =
  await MessageRepository.isMessageFlaggedByMe(messageId);

updateUI({ isFlaggedByMe });

let isFlaggedByMe = try await messageRepository
    .isMessageFlaggedByMe(withId: "message-id")

showSuccessMessage(isFlaggedByMe)

messageRepository
    .getMessage(messageId = messageId)
    .subscribe(
        { fetchedMessage ->
            val isFlaggedByMe = fetchedMessage.isFlaggedByMe()
            updateMessageUI(messageId, isFlaggedByMe)
        },
        { error -> handleGeneralError(error) },
    )

final fetchedMessage = await AmityChatClient.newMessageRepository()
    .getMessage(messageId);

final isFlaggedByMe = fetchedMessage.isFlaggedByMe;

Query Messages

Refresh list state after flag or unflag actions.

Edit and Delete Messages

Modify or soft-delete your own messages.

Content Moderation

Connect message reports to your moderation operating model.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Platform Surface

Parameters

Flag A Message

Use A Custom Reason

Unflag A Message

Check Flag State

Query Messages

Edit and Delete Messages

Content Moderation

​Platform Surface

​Parameters

​Flag A Message

​Use A Custom Reason

​Unflag A Message

​Check Flag State

​Related Topics

Query Messages

Edit and Delete Messages

Content Moderation

Platform Surface

Parameters

Flag A Message

Use A Custom Reason

Unflag A Message

Check Flag State

Related Topics