Reporting
Accepted report reasons and the moderation ticket returned by report methods.
ReportReason
ReportReason is a constant object that contains each reason accepted by .report() methods. Import these named values. TypeScript can then find a spelling error.
const ReportReason = {
Spam: 'Spam',
HarassmentOrBullying: 'Harassment or bullying',
HateSpeechOrDiscrimination: 'Hate speech or discrimination',
Misinformation: 'Misinformation',
SexualContent: 'Sexual content',
ViolenceOrThreats: 'Violence or threats',
SelfHarm: 'Self-harm',
Other: 'Other',
} as constUse it like this:
import { PackbaseSDK, ReportReason } from '@packbase/sdk-ts'
const pb = new PackbaseSDK({ apiKey: 'your-api-key' })
const ticket = await pb.howls('howl-id').report(
ReportReason.Spam,
'Optional context for the moderation team.',
)
console.log(ticket.id, ticket.status)The first argument is required. The second is an optional note. Howls, packs, and profiles all use the same reason values.
ReportReasonValue
ReportReasonValue is the union of the strings in ReportReason. Use this type when a function accepts a report reason:
import type { ReportReasonValue } from '@packbase/sdk-ts'
function chooseReason(reason: ReportReasonValue) {
return reason
}ReportResult
Successful report methods return the moderation ticket created by Packbase:
interface ReportResult {
id: string
status: string
}