Class ForumPosts

constructor

• new ForumPosts(e621: E621<NoV2Options> | undefined, client: Client): ForumPosts

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Parameters

  • e621: E621<NoV2Options> | undefined
  • client: Client

  Returns ForumPosts

Static ReadonlymoduleKey

create

• create(options: CreateForumPostOptions): Promise<ForumPost>
  Requires Api Key Auth

  Parameters

  • options: CreateForumPostOptions

  Returns Promise<ForumPost>

  Operation Id

  forum_posts#create

  See

  Documentation for more details.

delete

• delete(id: number): Promise<null>
  Requires Api Key Auth

  You must be Admin+.

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  forum_posts#destroy

  See

  Documentation for more details.

get

• get(id: number): Promise<ForumPost | null>

  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.

hide

• hide(id: number): Promise<ForumPost>
  Requires Api Key Auth

  You must be the creator or Moderator+.

  Parameters

  • id: number

  Returns Promise<ForumPost>

  Operation Id

  forum_posts#hide

  See

  Documentation for more details.

mark

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

  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.

search

• search(options?: SearchForumPostsOptions): Promise<ForumPost[]>

  Parameters

  • Optionaloptions: SearchForumPostsOptions

  Returns Promise<ForumPost[]>

  Operation Id

  forum_posts#index

  See

  Documentation for more details.

unhide

• unhide(id: number): Promise<ForumPost>
  Requires Api Key Auth

  You must be Moderator+.

  Parameters

  • id: number

  Returns Promise<ForumPost>

  Operation Id

  forum_posts#unhide

  See

  Documentation for more details.

update

• update(id: number, options: UpdateForumPostOptions): Promise<null>
  Requires Api Key Auth

  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.