Class Blip

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Blip
Base<BlipData>
- Blip

Index

Constructors

Methods

[custom] delete destroy edit mark toJSON undelete

Constructors

constructor

new Blip(e621: E621, data: Blip): Blip
Parameters
- e621: E621
- data: Blip
Returns Blip
Inherited from Base.constructor
- Defined in lib/models/Base.ts:10

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

delete

delete(): Promise<Blip>
Requires Api Key Auth
Delete Blip

Soft deletion. You must be the creator or Moderator+.

Returns Promise<Blip>
Operation Id
deleteBlip

See
Documentation for more details.
- Defined in lib/models/Blip.ts:31

destroy

destroy(): Promise<null>
Requires Api Key Auth
Destroy Blip

You must be Admin+.

Returns Promise<null>
Operation Id
destroyBlip

See
Documentation for more details.
- Defined in lib/models/Blip.ts:48

edit

edit(options: EditBlipOptions): Promise<null>
Requires Api Key Auth
Edit Blip

Unless Admin+, blips cannot be edited after 5 minutes. Marked blips cannot be edited.
Parameters
- options: EditBlipOptions
Returns Promise<null>
Operation Id
editBlip

See
Documentation for more details.
- Defined in lib/models/Blip.ts:64

mark

mark(type: "unmark" | "ban" | "record" | "warning"): Promise<MarkBlipResponse>
Requires Api Key Auth
Mark Blip

You must be Moderator+.
Parameters
- type: "unmark" | "ban" | "record" | "warning"
Returns Promise<MarkBlipResponse>
Operation Id
markBlip

See
Documentation for more details.
- Defined in lib/models/Blip.ts:80

toJSON

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

undelete

undelete(): Promise<Blip>
Requires Api Key Auth
Undelete Blip

You must be Moderator+.

Returns Promise<Blip>
Operation Id
undeleteBlip

See
Documentation for more details.
- Defined in lib/models/Blip.ts:97