Flag A Message

Flagging messages allows users to report inappropriate content to moderators or administrators. CometChat provides methods to flag messages with specific reasons and retrieve available flag reasons configured in your dashboard.

Flag a Message

In other words, as a user, how do I report a message?

To flag a message, you can use the flagMessage() method. This method takes the message ID and a payload containing an optional reason ID and remark.

Swift

let flagDetail = FlagDetail(messageId: message.id, reasonId: reason.id, remark: "i find this inappropriate")
                
CometChat.flagMessage(messageId: message.id, detail: <#T##FlagDetail#>) { flagResponse in
    print(flagResponse)
} onError: { error in
    print(error?.errorDescription)
}

Parameters

Parameter	Type	Required	Description
id	long	Yes	The ID of the message to be flagged
flagDetail	FlagDetail	Yes	Contains flagging details
flagDetail.setReasonId	String	Yes	ID of the flag reason (from getFlagReasons)
flagDetail.setRemark	String	No	Additional context or explanation

Response

On successful flagging, you’ll receive a response object:

{
  "message": "Message {id} has been flagged successfully."
}

Get Flag Reasons

In other words, what are the available reasons for flagging a message?

Before flagging a message, you can retrieve the list of available flag reasons using the getFlagReasons() method. These reasons are configured in the CometChat Dashboard.

Swift

CometChat.getFlagReasons { reasons in
    print("flag reasons: \(reasons)")
} onError: { error in
    print(error?.errorDescription)
}