Class ForumTopic

Schema

See

Documentation for more details.

Hierarchy (View Summary)

ForumTopic
Base<ForumTopicData>
- ForumTopic

Index

Constructors

Methods

[custom] delete hide subscribe toJSON unhide unsubscribe update

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:10

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:18

delete

delete(): Promise<null>
Requires Api Key Auth
You must be Admin+.

Returns Promise<null>

Operation Id
forum_topics#destroy

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

hide

hide(): Promise<ForumTopic>
Requires Api Key Auth
You must be the creator or Moderator+.

Returns Promise<ForumTopic>

Operation Id
forum_topics#hide

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

subscribe(): Promise<ForumTopic>
Requires Api Key Auth
Returns Promise<ForumTopic>

Operation Id
forum_topics#subscribe

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

toJSON

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

unhide

unhide(): Promise<ForumTopic>
Requires Api Key Auth
You must be Moderator+.

Returns Promise<ForumTopic>

Operation Id
forum_topics#unhide

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

unsubscribe

unsubscribe(): Promise<ForumTopic>
Requires Api Key Auth
Returns Promise<ForumTopic>

Operation Id
forum_topics#unsubscribe

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

update

update(options: UpdateForumTopicOptions): Promise<null>
Requires Api Key Auth
Parameters
- options: UpdateForumTopicOptions
Returns Promise<null>

Operation Id
forum_topics#update

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