Class Blips

Hierarchy (View Summary)

Base
- Blips

Index

Constructors

Methods

create delete destroy edit get mark search undelete

Constructors

constructor

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

Methods

create

create(options: CreateBlipOptions): Promise<Blip>
Requires Api Key Auth
Create Blip
Parameters
- options: CreateBlipOptions
Returns Promise<Blip>
Operation Id
createBlip

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

delete

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

Soft deletion. You must be the creator or Moderator+.
Parameters
- id: number
Returns Promise<Blip>
Operation Id
deleteBlip

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:71

destroy

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

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

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:91

edit

edit(id: number, 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
- id: number
- options: EditBlipOptions
Returns Promise<null>
Operation Id
editBlip

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:110

get

get(id: number): Promise<Blip | null>
Get Blip
Parameters
- id: number
Returns Promise<Blip | null>
Operation Id
getBlip

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:126

mark

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

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

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:145

search

search(options?: SearchBlipsOptions): Promise<Blip[]>
Search Blips
Parameters
- Optionaloptions: SearchBlipsOptions
Returns Promise<Blip[]>
Operation Id
searchBlips

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:161

undelete

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

You must be Moderator+.
Parameters
- id: number
Returns Promise<Blip>
Operation Id
undeleteBlip

See
Documentation for more details.
- Defined in lib/modules/Blips.ts:181