Class ForumPost

Schema

See

Documentation for more details.

Hierarchy (View Summary)

ForumPost
Base<ForumPostData>
- ForumPost

Index

Constructors

Methods

[custom] delete edit hide mark toJSON unhide unvote vote

Constructors

constructor

new ForumPost(e621: E621, data: ForumPost): ForumPost
Parameters
- e621: E621
- data: ForumPost
Returns ForumPost
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

delete

delete(): Promise<null>
Requires Api Key Auth
Delete Forum Post

You must be Admin+.

Returns Promise<null>
Operation Id
deleteForumPost

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

edit

edit(options: EditForumPostOptions): Promise<null>
Requires Api Key Auth
Edit Forum Post

You must be the creator of the forum post, or Admin+ to edit. Marked forum posts cannot be edited.
Parameters
- options: EditForumPostOptions
Returns Promise<null>
Operation Id
editForumPost

See
Documentation for more details.
- Defined in lib/models/ForumPost.ts:45

hide

hide(): Promise<ForumPost>
Requires Api Key Auth
Hide Forum Post

You must be the creator or Moderator+.

Returns Promise<ForumPost>
Operation Id
hideForumPost

See
Documentation for more details.
- Defined in lib/models/ForumPost.ts:61

mark

mark(
type: "unmark" | "ban" | "record" | "warning",
): Promise<MarkForumPostResponse>
Requires Api Key Auth
Mark Forum Post

You must be Moderator+.
Parameters
- type: "unmark" | "ban" | "record" | "warning"
Returns Promise<MarkForumPostResponse>
Operation Id
markForumPost

See
Documentation for more details.
- Defined in lib/models/ForumPost.ts:78

toJSON

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

unhide

unhide(): Promise<ForumPost>
Requires Api Key Auth
Unhide Forum Post

You must be Moderator+.

Returns Promise<ForumPost>
Operation Id
unhideForumPost

See
Documentation for more details.
- Defined in lib/models/ForumPost.ts:94

unvote

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

Returns Promise<null>
Operation Id
deleteForumPostVote

See
Documentation for more details.
- Defined in lib/models/ForumPost.ts:108

vote

vote(score: -1 | 0 | 1): Promise<CreateForumPostVoteResponse>
Requires Api Key Auth
Create Forum Post Vote
Parameters
- score: -1 | 0 | 1
Returns Promise<CreateForumPostVoteResponse>
Operation Id
createForumPostVote

See
Documentation for more details.
- Defined in lib/models/ForumPost.ts:122