Class ForumPosts

Hierarchy (View Summary)

Base
- ForumPosts

Index

Constructors

Methods

create delete get hide mark search unhide update

Constructors

constructor

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

Methods

create

create(options: CreateForumPostOptions): Promise<ForumPost>
Requires Api Key Auth
Create Forum Post
Parameters
- options: CreateForumPostOptions
Returns Promise<ForumPost>

Operation Id
forum_posts#create

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:52

delete

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

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

Operation Id
forum_posts#destroy

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:71

get

get(id: number): Promise<ForumPost | null>
Get Forum Post

If the forum post is hidden, you must be the creator or Moderator+ to see it.
Parameters
- id: number
Returns Promise<ForumPost | null>

Operation Id
forum_posts#show

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:88

hide

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

You must be the creator or Moderator+.
Parameters
- id: number
Returns Promise<ForumPost>

Operation Id
forum_posts#hide

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:107

mark

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

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

Operation Id
forum_posts#warning

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:127

search

search(options?: SearchForumPostsOptions): Promise<ForumPost[]>
Forum Posts Index
Parameters
- Optionaloptions: SearchForumPostsOptions
Returns Promise<ForumPost[]>

Operation Id
forum_posts#index

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:143

unhide

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

You must be Moderator+.
Parameters
- id: number
Returns Promise<ForumPost>

Operation Id
forum_posts#unhide

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:162

update

update(id: number, 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
- id: number
- options: UpdateForumPostOptions
Returns Promise<null>

Operation Id
forum_posts#update

See
Documentation for more details.
- Defined in lib/modules/ForumPosts.ts:181