Class Blip

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Blip
Base<BlipData>
- Blip

Index

Constructors

Methods

[custom] delete destroy mark toJSON undelete update

Constructors

constructor

new Blip(e621: E621<NoV2Options>, data: Blip): Blip
Parameters
- e621: E621<NoV2Options>
- data: Blip
Returns Blip
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<string>
Requires Api Key Auth
Soft deletion. You must be the creator or Moderator+.

Returns Promise<string>

Operation Id
blips#delete

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

destroy

destroy(): Promise<null>
Requires Api Key Auth
You must be Admin+.

Returns Promise<null>

Operation Id
blips#destroy

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

mark

mark(
type: "unmark" | "ban" | "record" | "warning",
): Promise<BlipsWarningResponse>
Requires Api Key Auth
You must be Moderator+.
Parameters
- type: "unmark" | "ban" | "record" | "warning"
Returns Promise<BlipsWarningResponse>

Operation Id
blips#warning

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

toJSON

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

undelete

undelete(): Promise<string>
Requires Api Key Auth
You must be Moderator+.

Returns Promise<string>

Operation Id
blips#undelete

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

update

update(options: UpdateBlipOptions): Promise<null>
Requires Api Key Auth
Unless Admin+, blips cannot be edited after 5 minutes. Marked blips cannot be edited.
Parameters
- options: UpdateBlipOptions
Returns Promise<null>

Operation Id
blips#update

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