Class HelpPages

Hierarchy (View Summary)

Base
- HelpPages

Index

Constructors

Methods

create delete get landing list update

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

Methods

create

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

You must be Admin+.
Parameters
- options: CreateHelpPageOptions
Returns Promise<HelpPage>

Operation Id
help#create

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

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
help#destroy

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

get

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

Operation Id
help#show

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

landing

landing(): Promise<HelpPage>
Get Landing Help Page

Returns Promise<HelpPage>

Operation Id
help#index

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

list

list(): Promise<HelpPage[]>
Help Pages Index

Returns Promise<HelpPage[]>

Operation Id
help#list

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

update

update(id: number, options: UpdateHelpPageOptions): Promise<null>
Requires Api Key Auth
Update Help Page

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

Operation Id
help#update

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