Class ForumTopics

constructor

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

  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 ForumTopics

Static ReadonlymoduleKey

create

• create(options: CreateForumTopicOptions): Promise<ForumTopic>
  Requires Api Key Auth

  Parameters

  • options: CreateForumTopicOptions

  Returns Promise<ForumTopic>

  Operation Id

  forum_topics#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_topics#destroy

  See

  Documentation for more details.

get

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

  If the forum topic is hidden, you must be the creator or Moderator+ to see it.

  Parameters

  • id: number

  Returns Promise<ForumTopic | null>

  Operation Id

  forum_topics#show

  See

  Documentation for more details.

hide

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

  You must be the creator or Moderator+.

  Parameters

  • id: number

  Returns Promise<ForumTopic>

  Operation Id

  forum_topics#hide

  See

  Documentation for more details.

markAllRead

• markAllRead(): Promise<null>
  Requires Api Key Auth

  Returns Promise<null>

  Operation Id

  forum_topics#mark_all_as_read

  See

  Documentation for more details.

search

• search(options?: SearchForumTopicsOptions): Promise<ForumTopic[]>

  Parameters

  • Optionaloptions: SearchForumTopicsOptions

  Returns Promise<ForumTopic[]>

  Operation Id

  forum_topics#index

  See

  Documentation for more details.

subscribe

• subscribe(id: number): Promise<ForumTopic>
  Requires Api Key Auth

  Parameters

  • id: number

  Returns Promise<ForumTopic>

  Operation Id

  forum_topics#subscribe

  See

  Documentation for more details.

unhide

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

  You must be Moderator+.

  Parameters

  • id: number

  Returns Promise<ForumTopic>

  Operation Id

  forum_topics#unhide

  See

  Documentation for more details.

unsubscribe

• unsubscribe(id: number): Promise<ForumTopic>
  Requires Api Key Auth

  Parameters

  • id: number

  Returns Promise<ForumTopic>

  Operation Id

  forum_topics#unsubscribe

  See

  Documentation for more details.

update

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

  Parameters

  • id: number
  • options: UpdateForumTopicOptions

  Returns Promise<null>

  Operation Id

  forum_topics#update

  See

  Documentation for more details.