Class WikiPages

Hierarchy (View Summary)

Base
- WikiPages

Index

Constructors

Methods

create delete edit get revert search

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

Methods

create

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

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

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
deleteWikiPage

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

edit

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

You must be Janitor+ if the wiki page is locked.
Parameters
- id: number
- options: EditWikiPageOptions
Returns Promise<null>
Operation Id
editWikiPage

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

get

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

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

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
revertWikiPage

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

search

search(options?: SearchWikiPagesOptions): Promise<WikiPage[]>
Search Wiki Pages
Parameters
- Optionaloptions: SearchWikiPagesOptions
Returns Promise<WikiPage[]>
Operation Id
searchWikiPages

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