Class Post

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Post
Base<PostData>
- Post

Index

Constructors

Methods

[custom] aiCheck copyNotes delete expunge favorites markTranslated moveFavorites regenerateThumbnails regenerateVideos revert toJSON undelete unvote updateIqdb vote

Constructors

constructor

new Post(e621: E621, data: Post): Post
Parameters
- e621: E621
- data: Post
Returns Post
Inherited from Base.constructor
- Defined in lib/models/Base.ts:9

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:17

aiCheck

aiCheck(): Promise<string>
Requires Api Key Auth
AI Check Post

You must be Janitor+.

Returns Promise<string>
Operation Id
aiCheckPost

See
Documentation for more details.
- Defined in lib/models/Post.ts:29

copyNotes

copyNotes(other_post_id: number): Promise<null>
Requires Api Key Auth
Copy Notes To Post
Parameters
- other_post_id: number
Returns Promise<null>
Operation Id
copyNotesToPost

See
Documentation for more details.
- Defined in lib/models/Post.ts:43

delete

delete(options: DeletePostOptions): Promise<unknown>
Requires Api Key Auth
Delete Post

You must have the "Approve Posts" permission. commit=Delete must be set.
Parameters
- options: DeletePostOptions
Returns Promise<unknown>
Operation Id
deletePost

See
Documentation for more details.
- Defined in lib/models/Post.ts:59

expunge

expunge(reason: string): Promise<Post>
Requires Api Key Auth
Expunge Post

You must have the "Approve Posts" permission and be Admin+.
Parameters
- reason: string
Returns Promise<Post>
Operation Id
expungePost

See
Documentation for more details.
- Defined in lib/models/Post.ts:75

favorites

favorites(options: ListPostFavoritesOptions): Promise<Post[]>
List Post Favorites

You must be the user or Moderator+ to see users that have their favorites hidden.
Parameters
- options: ListPostFavoritesOptions
Returns Promise<Post[]>
Operation Id
listPostFavorites

See
Documentation for more details.
- Defined in lib/models/Post.ts:89

markTranslated

markTranslated(): Promise<Post>
Requires Api Key Auth
Mark Post As Translated

Will error if no body is provided.

Returns Promise<Post>
Operation Id
markPostAsTranslated

See
Documentation for more details.
- Defined in lib/models/Post.ts:105

moveFavorites

moveFavorites(options: MovePostFavoritesOptions): Promise<unknown>
Requires Api Key Auth
Move Post Favorites

You must have the "Approve Posts" permission. `commit=Submit`` must be set.
Parameters
- options: MovePostFavoritesOptions
Returns Promise<unknown>
Operation Id
movePostFavorites

See
Documentation for more details.
- Defined in lib/models/Post.ts:121

regenerateThumbnails

regenerateThumbnails(): Promise<Post>
Requires Api Key Auth
Regenerate Post Thumbnails

You must be Janitor+.

Returns Promise<Post>
Operation Id
regeneratePostThumbnails

See
Documentation for more details.
- Defined in lib/models/Post.ts:137

regenerateVideos

regenerateVideos(): Promise<null>
Requires Api Key Auth
Regenerate Post Videos

You must be Janitor+.

Returns Promise<null>
Operation Id
regeneratePostVideos

See
Documentation for more details.
- Defined in lib/models/Post.ts:153

revert

revert(version_id: number): Promise<null>
Requires Api Key Auth
Revert Post
Parameters
- version_id: number
Returns Promise<null>
Operation Id
revertPost

See
Documentation for more details.
- Defined in lib/models/Post.ts:167

toJSON

toJSON(): Post
Returns Post
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:39

undelete

undelete(): Promise<Post>
Requires Api Key Auth
Undelete Post

You must have the "Approve Posts" permission.

Returns Promise<Post>
Operation Id
undeletePost

See
Documentation for more details.
- Defined in lib/models/Post.ts:183

unvote

unvote(): Promise<null>
Requires Api Key Auth
Delete Post Vote

Returns Promise<null>
Operation Id
deletePostVote

See
Documentation for more details.
- Defined in lib/models/Post.ts:197

updateIqdb

updateIqdb(): Promise<Post>
Requires Api Key Auth
Update Post IQDB

You must be Admin+.

Returns Promise<Post>
Operation Id
updatePostIqdb

See
Documentation for more details.
- Defined in lib/models/Post.ts:213

vote

vote(score: -1 | 1, no_unvote?: boolean): Promise<CreatePostVoteResponse>
Requires Api Key Auth
Create Post Vote
Parameters
- score: -1 | 1
- Optionalno_unvote: boolean
Returns Promise<CreatePostVoteResponse>
Operation Id
createPostVote

See
Documentation for more details.
- Defined in lib/models/Post.ts:227