Class Sticker

Represents an sticker.

Implements

Sticker

Index

Constructors

Accessors

format id name previewImageURL

Methods

[custom] toJSON toString

Constructors

constructor

new Sticker(
    client: Client,
    data:
        | StickerStorageJSON
        | StickerCacheJSON
        | APISticker
        | StickerDiscordJSON,
): Sticker
Creates the structure for a sticker
Parameters
- client: Client
  The client instance.
- data: StickerStorageJSON | StickerCacheJSON | APISticker | StickerDiscordJSON
  Sticker data from Discord.
Returns Sticker
- Defined in src/structures/Sticker.ts:26

Accessors

format

get format(): StickerFormatType
The format of the sticker.

Returns StickerFormatType
Implementation of StickerType.format
- Defined in src/structures/Sticker.ts:94

id

get id(): string
The ID of the sticker.

Returns string
Implementation of StickerType.id
- Defined in src/structures/Sticker.ts:74

name

get name(): string
The name of the sticker.

Returns string
Implementation of StickerType.name
- Defined in src/structures/Sticker.ts:84

previewImageURL

get previewImageURL(): null | string
The URL to an image of the sticker. Returns NULL if image is a LOTTIE file.

Returns null | string
Implementation of StickerType.previewImageURL
- Defined in src/structures/Sticker.ts:104

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/Sticker.ts:137

toJSON

toJSON(
format?: JsonTypes,
): { format_type: StickerFormatType; id: string; name: string }
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns { format_type: StickerFormatType; id: string; name: string }
Method
Implementation of StickerType.toJSON
- Defined in src/structures/Sticker.ts:148

toString

toString(): string
Returns string
Method
Implementation of StickerType.toString
- Defined in src/structures/Sticker.ts:129