Class PostReplacements

Hierarchy (View Summary)

Base
- PostReplacements

Index

Constructors

Methods

approve create delete promote reject search togglePenalize

Constructors

constructor

new PostReplacements(e621: E621, client: Client): PostReplacements
Parameters
- e621: E621
- client: Client
Returns PostReplacements
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:19

Methods

approve

approve(id: number): Promise<null>
Requires Api Key Auth
Approve Post Replacement

You must have the "Approve Posts" permission.
Parameters
- id: number
Returns Promise<null>
Operation Id
approvePostReplacement

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:43

create

create(
options: CreatePostReplacementOptions,
): Promise<CreatePostReplacementResponse>
Requires Api Key Auth
Create Post Replacement
Parameters
- options: CreatePostReplacementOptions
Returns Promise<CreatePostReplacementResponse>
Operation Id
createPostReplacement

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:60

delete

delete(id: number): Promise<null>
Requires Api Key Auth
Delete Post Replacement

You must be Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
deletePostReplacement

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:79

promote

promote(id: number): Promise<Post>
Requires Api Key Auth
Promote Post Replacement

You must have the "Approve Posts" permission.
Parameters
- id: number
Returns Promise<Post>
Operation Id
promotePostReplacement

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:98

reject

reject(id: number): Promise<null>
Requires Api Key Auth
Reject Post Replacement

You must have the "Approve Posts" permission.
Parameters
- id: number
Returns Promise<null>
Operation Id
rejectPostReplacement

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:117

search

search(options?: SearchPostReplacementsOptions): Promise<PostReplacement[]>
Search Post Replacements

Rejected replacements can only be seen by staff.
Parameters
- Optionaloptions: SearchPostReplacementsOptions
Returns Promise<PostReplacement[]>
Operation Id
searchPostReplacements

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:134

togglePenalize

togglePenalize(id: number): Promise<null>
Requires Api Key Auth
Toggle Post Replacement Penalty

You must have the "Approve Posts" permission.
Parameters
- id: number
Returns Promise<null>
Operation Id
togglePostReplacementPenalty

See
Documentation for more details.
- Defined in lib/modules/PostReplacements.ts:153