Class ForumTopics

Hierarchy (View Summary)

Base
- ForumTopics

Index

Constructors

Methods

create delete get hide markAllRead search subscribe unhide unsubscribe update

Constructors

constructor

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

Methods

create

create(options: CreateForumTopicOptions): Promise<ForumTopic>
Requires Api Key Auth
Create Forum Topic
Parameters
- options: CreateForumTopicOptions
Returns Promise<ForumTopic>

Operation Id
forum_topics#create

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:39

delete

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

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

Operation Id
forum_topics#destroy

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:58

get

get(id: number): Promise<ForumTopic | null>
Get Forum Forum Topic

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.
- Defined in lib/modules/ForumTopics.ts:75

hide

hide(id: number): Promise<ForumTopic>
Requires Api Key Auth
Hide Forum Topic

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

Operation Id
forum_topics#hide

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:94

markAllRead

markAllRead(): Promise<null>
Requires Api Key Auth
Mark All Forum Topics As Read

Returns Promise<null>

Operation Id
forum_topics#mark_all_as_read

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:111

search

search(options?: SearchForumTopicsOptions): Promise<ForumTopic[]>
Forum Topics Index
Parameters
- Optionaloptions: SearchForumTopicsOptions
Returns Promise<ForumTopic[]>

Operation Id
forum_topics#index

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:125

subscribe(id: number): Promise<ForumTopic>
Requires Api Key Auth
Subscribe To Forum Topic
Parameters
- id: number
Returns Promise<ForumTopic>

Operation Id
forum_topics#subscribe

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:142

unhide

unhide(id: number): Promise<ForumTopic>
Requires Api Key Auth
Unhide Forum Topic

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

Operation Id
forum_topics#unhide

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:161

unsubscribe

unsubscribe(id: number): Promise<ForumTopic>
Requires Api Key Auth
Unsubscribe From Forum Topic
Parameters
- id: number
Returns Promise<ForumTopic>

Operation Id
forum_topics#unsubscribe

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:178

update

update(id: number, options: UpdateForumTopicOptions): Promise<null>
Requires Api Key Auth
Update Forum Topic
Parameters
- id: number
- options: UpdateForumTopicOptions
Returns Promise<null>

Operation Id
forum_topics#update

See
Documentation for more details.
- Defined in lib/modules/ForumTopics.ts:195