Class Blip

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Blip
Base<BlipData>
- Blip

Index

Constructors

Methods

[custom] delete edit hide mark toJSON unhide

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

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

delete

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

You must be Admin+.

Returns Promise<null>
Operation Id
deleteBlip

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

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

hide

hide(): Promise<Blip>
Requires Api Key Auth
Hide Blip

You must be the creator or Moderator+.

Returns Promise<Blip>
Operation Id
hideBlip

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

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

toJSON

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

unhide

unhide(): Promise<Blip>
Requires Api Key Auth
Unhide Blip

You must be Moderator+.

Returns Promise<Blip>
Operation Id
unhideBlip

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