Class ForumTopics

Hierarchy (View Summary)

Base
- ForumTopics

Index

Constructors

Methods

create delete edit get hide markAllRead search subscribe unhide unsubscribe

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

Methods

create

create(options: ForumTopicOptions): Promise<ForumTopic>
Requires Api Key Auth
Create Forum Topic
Parameters
- options: ForumTopicOptions
Returns Promise<ForumTopic>
Operation Id
createForumTopic

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

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
deleteForumTopic

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

edit

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

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

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
getForumTopic

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

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
hideForumTopic

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

markAllRead

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

Returns Promise<null>
Operation Id
markAllForumTopicsAsRead

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

search

search(options?: SearchForumTopicsOptions): Promise<ForumTopic[]>
Search Forum Topics
Parameters
- Optionaloptions: SearchForumTopicsOptions
Returns Promise<ForumTopic[]>
Operation Id
searchForumTopics

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

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

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

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
unhideForumTopic

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

unsubscribe

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

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