Class ForumPosts

constructor

• new ForumPosts(e621: E621, client: Client): ForumPosts

  Parameters

  • e621: E621
  • client: Client

  Returns ForumPosts

votes

create

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

  Create Forum Post

  Parameters

  • options: CreateForumPostOptions

  Returns Promise<ForumPost>

  Operation Id

  createForumPost

  See

  Documentation for more details.

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

  deleteForumPost

  See

  Documentation for more details.

edit

• edit(id: number, 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

  • id: number
  • options: EditForumPostOptions

  Returns Promise<null>

  Operation Id

  editForumPost

  See

  Documentation for more details.

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

  getForumPost

  See

  Documentation for more details.

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

  hideForumPost

  See

  Documentation for more details.

mark

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

  Mark Forum Post

  You must be Moderator+.

  Parameters

  • id: number
  • type: "unmark" | "ban" | "record" | "warning"

  Returns Promise<MarkForumPostResponse>

  Operation Id

  markForumPost

  See

  Documentation for more details.

search

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

  Search Forum Posts

  Parameters

  • Optionaloptions: SearchForumPostsOptions

  Returns Promise<ForumPost[]>

  Operation Id

  searchForumPosts

  See

  Documentation for more details.

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

  unhideForumPost

  See

  Documentation for more details.