Sticker
Defined in: packages/structures/src/sticker.ts:24
A sticker: a guild’s own, one from a Nitro pack, or a standard one.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Sticker(
data):Sticker
Defined in: packages/structures/src/sticker.ts:41
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Sticker
Overrides
Section titled “Overrides”Properties
Section titled “Properties”available
Section titled “available”
readonlyavailable:boolean
Defined in: packages/structures/src/sticker.ts:34
Whether the sticker can be used (guild stickers become unavailable when the boost level drops).
description
Section titled “description”
readonlydescription:string|null
Defined in: packages/structures/src/sticker.ts:26
formatType
Section titled “formatType”
readonlyformatType:number
Defined in: packages/structures/src/sticker.ts:32
1 PNG, 2 APNG, 3 Lottie, 4 GIF.
guildId
Section titled “guildId”
readonlyguildId:string|null
Defined in: packages/structures/src/sticker.ts:35
readonlyid:string
Defined in: packages/structures/src/base.ts:12
Inherited from
Section titled “Inherited from”
readonlyname:string
Defined in: packages/structures/src/sticker.ts:25
packId
Section titled “packId”
readonlypackId:string|null
Defined in: packages/structures/src/sticker.ts:36
sortValue
Section titled “sortValue”
readonlysortValue:number|null
Defined in: packages/structures/src/sticker.ts:37
readonlytags:string
Defined in: packages/structures/src/sticker.ts:28
Comma-separated autocomplete tags.
readonlytype:number
Defined in: packages/structures/src/sticker.ts:30
1 standard (from a pack), 2 guild.
readonlyuser:UserData|null
Defined in: packages/structures/src/sticker.ts:39
Who uploaded it, for guild stickers.
Accessors
Section titled “Accessors”animated
Section titled “animated”Get Signature
Section titled “Get Signature”get animated():
boolean
Defined in: packages/structures/src/sticker.ts:56
Whether the sticker moves: APNG, Lottie or GIF.
Returns
Section titled “Returns”boolean
createdAt
Section titled “createdAt”Get Signature
Section titled “Get Signature”get createdAt():
Date
Defined in: packages/structures/src/base.ts:29
Returns the timestamp this snowflake was created at.
Returns
Section titled “Returns”Date
Inherited from
Section titled “Inherited from”createdTimestamp
Section titled “createdTimestamp”Get Signature
Section titled “Get Signature”get createdTimestamp():
number
Defined in: packages/structures/src/base.ts:25
Milliseconds since the Unix epoch at which this snowflake was created.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”BaseStructure.createdTimestamp
Methods
Section titled “Methods”toItem()
Section titled “toItem()”toItem():
APIStickerItem
Defined in: packages/structures/src/sticker.ts:66
The sticker as a message carries it.
Returns
Section titled “Returns”toString()
Section titled “toString()”toString():
string
Defined in: packages/structures/src/base.ts:21
Returns the snowflake ID as a string.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”url(
options?):string
Defined in: packages/structures/src/sticker.ts:61
The sticker’s image URL (a .json file for Lottie).
Parameters
Section titled “Parameters”options?
Section titled “options?”number
Returns
Section titled “Returns”string