Class UploadWhitelists

Hierarchy (View Summary)

Base
- UploadWhitelists

Index

Constructors

Methods

check create delete edit search

Constructors

constructor

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

Methods

check

check(url: string): Promise<{}>
Requires Api Key Auth
Check If URL Is Allowed
Parameters
- url: string
Returns Promise<{}>
Operation Id
checkIfUrlIsAllowed

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

create

create(options: CreateUploadWhitelistOptions): Promise<UploadWhitelist>
Requires Api Key Auth
Create Upload Whitelist

You must be Admin+.
Parameters
- options: CreateUploadWhitelistOptions
Returns Promise<UploadWhitelist>
Operation Id
createUploadWhitelist

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

delete

delete(id: number): Promise<null>
Requires Api Key Auth
Delete Upload Whitelist

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

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

edit

edit(id: number, options: EditUploadWhitelistOptions): Promise<null>
Requires Api Key Auth
Edit Upload Whitelist
Parameters
- id: number
- options: EditUploadWhitelistOptions
Returns Promise<null>
Operation Id
editUploadWhitelist

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

search

search(options?: SearchUploadWhitelistsOptions): Promise<UploadWhitelist[]>
Search Upload Whitelists
Parameters
- Optionaloptions: SearchUploadWhitelistsOptions
Returns Promise<UploadWhitelist[]>
Operation Id
searchUploadWhitelists

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