Class ForumTopic

Schema

See

Documentation for more details.

Hierarchy (View Summary)

ForumTopic
Base<ForumTopicData>
- ForumTopic

Index

Constructors

Methods

[custom] delete edit hide subscribe toJSON unhide unsubscribe

Constructors

constructor

new ForumTopic(e621: E621, data: ForumTopic): ForumTopic
Parameters
- e621: E621
- data: ForumTopic
Returns ForumTopic
Inherited from Base.constructor
- Defined in lib/models/Base.ts:9

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:17

delete

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

You must be Admin+.

Returns Promise<null>
Operation Id
deleteForumTopic

See
Documentation for more details.
- Defined in lib/models/ForumTopic.ts:28

edit

edit(options: ForumTopicOptions): Promise<null>
Requires Api Key Auth
Edit Forum Topic
Parameters
- options: ForumTopicOptions
Returns Promise<null>
Operation Id
editForumTopic

See
Documentation for more details.
- Defined in lib/models/ForumTopic.ts:42

hide

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

You must be the creator or Moderator+.

Returns Promise<ForumTopic>
Operation Id
hideForumTopic

See
Documentation for more details.
- Defined in lib/models/ForumTopic.ts:58

subscribe(): Promise<ForumTopic>
Requires Api Key Auth
Subscribe To Forum Topic

Returns Promise<ForumTopic>
Operation Id
subscribeForumTopic

See
Documentation for more details.
- Defined in lib/models/ForumTopic.ts:72

toJSON

toJSON(): ForumTopic
Returns ForumTopic
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:39

unhide

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

You must be Moderator+.

Returns Promise<ForumTopic>
Operation Id
unhideForumTopic

See
Documentation for more details.
- Defined in lib/models/ForumTopic.ts:88

unsubscribe

unsubscribe(): Promise<ForumTopic>
Requires Api Key Auth
Unsubscribe From Forum Topic

Returns Promise<ForumTopic>
Operation Id
unsubscribeForumTopic

See
Documentation for more details.
- Defined in lib/models/ForumTopic.ts:102