@amityco/ts-sdk-react-native/dist/userRepository/api/flagUser.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { UserRepository } from '@amityco/ts-sdk-react-native'
 * const flagged = await UserRepository.flagUser('userId')
 * const flaggedBehavior = await UserRepository.flagUser('userId', {
 *   reportType: 'behavior',
 *   reason: 'Harassment or bullying',
 *   comment: 'optional free-text',
 * })
 * ```
 *
 * @param userId The ID of the user to be flagged
 * @param options Optional report metadata forwarded to the server as the request
 *   body: `reportType`, `reason`, `comment`. Only non-null fields are included.
 *   All validation is server-side; a bodyless call produces a typeless report.
 * @returns the flagged {@link Amity.User}
 *
 * @category User API
 * @async
 * */
export declare const flagUser: (userId: Amity.User['userId'], options?: Amity.UserReportOptions) => Promise<Amity.User>;
//# sourceMappingURL=flagUser.d.ts.map