Class ModerationAPI

Hierarchy

APIRequest
- ModerationAPI

Index

Constructors

constructor

Properties

Constructors

constructor

new ModerationAPI(opts: RequestOpts): ModerationAPI

Overrides APIRequest.constructor
- Defined in api/moderation.ts:9
Parameters
- opts: RequestOpts
Returns ModerationAPI

Properties

Protected _api

_api: IRequestStrategy

Protected _endpoint

_endpoint: string

Protected _headers

_headers: object

Protected _okuna

_okuna: Client

Defines an API request.

param

Protected _params

_params: RequestParams

Protected _paths

_paths: string[] = []

Protected _url

_url: string

requiresToken

requiresToken: boolean = true

Methods

_constructFormdata

_constructFormdata(opts?: object | null): FormData

Inherited from APIRequest._constructFormdata
- Defined in utils/APIRequest.ts:72
constructFormdata() Constructs a FormData instance from an object.

Parameters
- Default value opts: object | null = null
  
  the object to generate the FormData from
Returns FormData

approveModeratedObject

approveModeratedObject(id: number): Promise<any>

- Defined in api/moderation.ts:114
Parameters
- id: number
Returns Promise<any>

Protected delete

delete(): Promise<any>

Inherited from APIRequest.delete
- Defined in utils/APIRequest.ts:158
delete() DELETE request

Returns Promise<any>

generateHeaders

generateHeaders(contentType?: string | null): object

Inherited from APIRequest.generateHeaders
- Defined in utils/APIRequest.ts:42
generateHeaders() A function used to generate the headers that need to be passed to the request performee.

Parameters
- Default value contentType: string | null = null
Returns object

Protected get

get(): Promise<any>

Inherited from APIRequest.get
- Defined in utils/APIRequest.ts:98
get() GET request

Returns Promise<any>

getGlobalModeratedObjects

getGlobalModeratedObjects(opts: IGetGlobalModeratedObjects): Promise<any>

- Defined in api/moderation.ts:14
Parameters
- opts: IGetGlobalModeratedObjects
Returns Promise<any>

getModeratedObjectLogs

getModeratedObjectLogs(opts: IModeratedObject): Promise<any>

- Defined in api/moderation.ts:40
Parameters
- opts: IModeratedObject
Returns Promise<any>

getModeratedObjectReports

getModeratedObjectReports(opts: IModeratedObject): Promise<any>

- Defined in api/moderation.ts:54
Parameters
- opts: IModeratedObject
Returns Promise<any>

getModerationCategories

getModerationCategories(): Promise<any>

- Defined in api/moderation.ts:68
Returns Promise<any>

getUserModerationPenalties

getUserModerationPenalties(opts: LimitationParams): Promise<any>

- Defined in api/moderation.ts:74
Parameters
- opts: LimitationParams
Returns Promise<any>

getUserPendingModeratedObjectsCommunities

getUserPendingModeratedObjectsCommunities(opts: LimitationParams): Promise<any>

- Defined in api/moderation.ts:88
Parameters
- opts: LimitationParams
Returns Promise<any>

Protected patch

patch(body: object): Promise<any>

Inherited from APIRequest.patch
- Defined in utils/APIRequest.ts:143
patch() PATCH request

Parameters
- body: object
  
  Request body
Returns Promise<any>

Protected patchFormdata

patchFormdata(body: object): Promise<any>

Inherited from APIRequest.patchFormdata
- Defined in utils/APIRequest.ts:202
patchFormdata() PATCH request (multipart/form-data, application/x-www-form-urlencoded)

Parameters
- body: object
Returns Promise<any>

Protected post

post(body: object): Promise<any>

Inherited from APIRequest.post
- Defined in utils/APIRequest.ts:128
post() POST request

Parameters
- body: object
  
  Request body
Returns Promise<any>

Protected postFormdata

postFormdata(body: object): Promise<any>

Inherited from APIRequest.postFormdata
- Defined in utils/APIRequest.ts:187
postFormdata() POST request (multipart/form-data, application/x-www-form-urlencoded)

Parameters
- body: object
Returns Promise<any>

Protected put

put(body: object): Promise<any>

Inherited from APIRequest.put
- Defined in utils/APIRequest.ts:113
put() PUT request

Parameters
- body: object
  
  Request body
Returns Promise<any>

Protected putFormdata

putFormdata(body: object): Promise<any>

Inherited from APIRequest.putFormdata
- Defined in utils/APIRequest.ts:172
putFormdata() PUT request (multipart/form-data, application/x-www-form-urlencoded)

Parameters
- body: object
Returns Promise<any>

rejectModeratedObject

rejectModeratedObject(id: number): Promise<any>

- Defined in api/moderation.ts:120
Parameters
- id: number
Returns Promise<any>

unverifyModeratedObject

unverifyModeratedObject(id: number): Promise<any>

- Defined in api/moderation.ts:108
Parameters
- id: number
Returns Promise<any>

updateModeratedObject

updateModeratedObject(id: number, opts: IUpdateModeratedObject): Promise<any>

- Defined in api/moderation.ts:126
Parameters
- id: number
- opts: IUpdateModeratedObject
Returns Promise<any>

verifyModeratedObject

verifyModeratedObject(id: number): Promise<any>

- Defined in api/moderation.ts:102
Parameters
- id: number
Returns Promise<any>

Generated using TypeDoc