Class ForumPost

Schema

See

Documentation for more details.

Hierarchy (View Summary)

ForumPost
Base<ForumPostData>
- ForumPost

Index

Constructors

Methods

[custom] delete hide mark toJSON unhide unvote update vote votes

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:10

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:18

delete

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

You must be Admin+.

Returns Promise<null>

Operation Id
forum_posts#destroy

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

hide

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

You must be the creator or Moderator+.

Returns Promise<ForumPost>

Operation Id
forum_posts#hide

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

mark

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

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

Operation Id
forum_posts#warning

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

toJSON

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

unhide

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

You must be Moderator+.

Returns Promise<ForumPost>

Operation Id
forum_posts#unhide

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

unvote

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

Returns Promise<null>

Operation Id
forum_post_votes#destroy

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

update

update(options: UpdateForumPostOptions): Promise<null>
Requires Api Key Auth
Update Forum Post

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

Operation Id
forum_posts#update

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

vote

vote(score: UpDownMehVote): Promise<ForumPostVotesCreateResponse>
Requires Api Key Auth
Create Forum Post Vote
Parameters
- score: UpDownMehVote
Returns Promise<ForumPostVotesCreateResponse>

Operation Id
forum_post_votes#create

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

votes

votes(): Promise<ForumPostVote[]>
Requires Api Key Auth
Forum Post Votes Index

Returns Promise<ForumPostVote[]>

Operation Id
forum_post_votes#show

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