@stackend/api/abuse/index.d.ts

JS bindings to api.stackend.com

import { XcapJsonResult, Thunk, XcapOptionalParameters } from '../api';
/**
 * Component name
 */
export declare const COMPONENT_NAME = "abuse";
export declare const TYPE_ABUSE = "net.josh.community.abuse.ReferencedAbuse";
/**
 * Send an abuse report for an object.
 *
 * Only authorized users may create abuse reports
 *
 * @param obfuscatedReference {String}
 * @param abuseText {String}
 * @param componentName Optional component name used for config (for example "like")
 * @param context Optional community context used for config (for example "forum")
 */
export declare function report({ obfuscatedReference, abuseText, context, componentName }: {
    obfuscatedReference: string;
    abuseText: string;
    context?: string | null;
    componentName?: string | null;
} & XcapOptionalParameters): Thunk<Promise<XcapJsonResult>>;
//# sourceMappingURL=index.d.ts.map