Class HelpPages

Hierarchy (View Summary)

Base
- HelpPages

Index

Constructors

Methods

create delete edit get list

Constructors

constructor

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

Methods

create

create(options: CreateHelpPageOptions): Promise<Help>
Requires Api Key Auth
Create Help Page

You must be Admin+.
Parameters
- options: CreateHelpPageOptions
Returns Promise<Help>
Operation Id
createHelpPage

See
Documentation for more details.
- Defined in lib/modules/HelpPages.ts:32

delete

delete(id: number): Promise<null>
Requires Api Key Auth
Delete Help Page

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

See
Documentation for more details.
- Defined in lib/modules/HelpPages.ts:51

edit

edit(id: number, options: EditHelpPageOptions): Promise<null>
Requires Api Key Auth
Edit Help Page

You must be Admin+
Parameters
- id: number
- options: EditHelpPageOptions
Returns Promise<null>
Operation Id
editHelpPage

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

get

get(id: string | number): Promise<Help | null>
Get Help Page
Parameters
- id: string | number
Returns Promise<Help | null>
Operation Id
getHelpPage

See
Documentation for more details.
- Defined in lib/modules/HelpPages.ts:86

list

list(): Promise<Help[]>
List Help Pages

Will error if no help pages exist.

Returns Promise<Help[]>
Operation Id
listHelpPages

See
Documentation for more details.
- Defined in lib/modules/HelpPages.ts:103