Skip to content

Sticker

Defined in: packages/structures/src/sticker.ts:24

A sticker: a guild’s own, one from a Nitro pack, or a standard one.

new Sticker(data): Sticker

Defined in: packages/structures/src/sticker.ts:41

APISticker

Sticker

BaseStructure.constructor

readonly available: boolean

Defined in: packages/structures/src/sticker.ts:34

Whether the sticker can be used (guild stickers become unavailable when the boost level drops).


readonly description: string | null

Defined in: packages/structures/src/sticker.ts:26


readonly formatType: number

Defined in: packages/structures/src/sticker.ts:32

1 PNG, 2 APNG, 3 Lottie, 4 GIF.


readonly guildId: string | null

Defined in: packages/structures/src/sticker.ts:35


readonly id: string

Defined in: packages/structures/src/base.ts:12

BaseStructure.id


readonly name: string

Defined in: packages/structures/src/sticker.ts:25


readonly packId: string | null

Defined in: packages/structures/src/sticker.ts:36


readonly sortValue: number | null

Defined in: packages/structures/src/sticker.ts:37


readonly tags: string

Defined in: packages/structures/src/sticker.ts:28

Comma-separated autocomplete tags.


readonly type: number

Defined in: packages/structures/src/sticker.ts:30

1 standard (from a pack), 2 guild.


readonly user: UserData | null

Defined in: packages/structures/src/sticker.ts:39

Who uploaded it, for guild stickers.

get animated(): boolean

Defined in: packages/structures/src/sticker.ts:56

Whether the sticker moves: APNG, Lottie or GIF.

boolean


get createdAt(): Date

Defined in: packages/structures/src/base.ts:29

Returns the timestamp this snowflake was created at.

Date

BaseStructure.createdAt


get createdTimestamp(): number

Defined in: packages/structures/src/base.ts:25

Milliseconds since the Unix epoch at which this snowflake was created.

number

BaseStructure.createdTimestamp

toItem(): APIStickerItem

Defined in: packages/structures/src/sticker.ts:66

The sticker as a message carries it.

APIStickerItem


toString(): string

Defined in: packages/structures/src/base.ts:21

Returns the snowflake ID as a string.

string

BaseStructure.toString


url(options?): string

Defined in: packages/structures/src/sticker.ts:61

The sticker’s image URL (a .json file for Lottie).

number

string