Class StaffFile

Schema

See

Documentation for more details.

Hierarchy (View Summary)

StaffFile
Base<StaffFileData>
- StaffFile

Index

Constructors

Methods

[custom] delete toJSON update

Constructors

constructor

new StaffFile(e621: E621<NoV2Options>, data: StaffFile): StaffFile
Parameters
- e621: E621<NoV2Options>
- data: StaffFile
Returns StaffFile
Inherited from Base.constructor
- Defined in lib/models/Base.ts:11

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:19

delete

delete(): Promise<null>
Requires Api Key Auth
You must be Admin+ if you did not created the file, else Staff+

Returns Promise<null>

Operation Id
staff/files#destroy

See
Documentation for more details.
- Defined in lib/models/StaffFile.ts:29

toJSON

toJSON(): StaffFile
Returns StaffFile
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:41

update

update(options: UpdateStaffFileOptions): Promise<null>
Requires Api Key Auth
You must be Admin+ if you did not create the file, else Staff+
Parameters
- options: UpdateStaffFileOptions
Returns Promise<null>

Operation Id
staff/files#update

See
Documentation for more details.
- Defined in lib/models/StaffFile.ts:44