Class WikiPages

Hierarchy (View Summary)

Base
- WikiPages

Index

Constructors

Methods

create delete get revert search update

Constructors

constructor

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

Methods

create

create(options: CreateWikiPageOptions): Promise<WikiPage>
Requires Api Key Auth
Create Wiki Page
Parameters
- options: CreateWikiPageOptions
Returns Promise<WikiPage>

Operation Id
wiki_pages#create

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

delete

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

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

Operation Id
wiki_pages#destroy

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

get

get(id: number): Promise<WikiPage | null>
Get Wiki Page
Parameters
- id: number
Returns Promise<WikiPage | null>

Operation Id
wiki_pages#show

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

revert

revert(id: number, version_id: number): Promise<null>
Requires Api Key Auth
Revert Wiki Page
Parameters
- id: number
- version_id: number
Returns Promise<null>

Operation Id
wiki_pages#revert

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

search

search(options?: SearchWikiPagesOptions): Promise<WikiPage[]>
Wiki Pages Index
Parameters
- Optionaloptions: SearchWikiPagesOptions
Returns Promise<WikiPage[]>

Operation Id
wiki_pages#index

See
Documentation for more details.
- Defined in lib/modules/WikiPages.ts:102

update

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

You must be Staff+ if the wiki page is locked.
Parameters
- id: number
- options: UpdateWikiPageOptions
Returns Promise<null>

Operation Id
wiki_pages#update

See
Documentation for more details.
- Defined in lib/modules/WikiPages.ts:121