Skip to content
SinisterRectus edited this page Nov 19, 2023 · 1 revision

extends Snowflake

Represents a sticker object.

Instances of this class should not be constructed by users.

Properties Inherited From Snowflake

Name Type Description
client Client A shortcut to the client object to which this container is visible.
createdAt number The Unix time in seconds at which this object was created by Discord. Additional decimal points may be present, though only the first 3 (milliseconds) should be considered accurate. Equivalent to Date.parseSnowflake(Snowflake.id).
id string The Snowflake ID that can be used to identify the object. This is guaranteed to be unique except in cases where an object shares the ID of its parent.
parent Container/Client The parent object of to which this container is a child. For example, the parent of a role is the guild in which the role exists.
timestamp string The date and time at which this object was created by Discord, represented as an ISO 8601 string plus microseconds when available. Equivalent to Date.fromSnowflake(Snowflake.id):toISO().

Properties

Name Type Description
description string The description of the sticker.
guild Guild The guild in which the sticker exists.
name string The name of the sticker.
tags string The tags of the sticker.
url string The URL that can be used to view a full version of the sticker.

Methods Inherited From Snowflake

__eq()

Defines the behavior of the == operator. Allows containers to be directly compared according to their type and __hash return values.

Returns: boolean


__hash()

Returns Snowflake.id

Returns: string


__tostring()

Defines the behavior of the tostring function. All containers follow the format ClassName: hash.

Returns: string


getDate()

Returns a unique Date object that represents when the object was created by Discord. Equivalent to Date.fromSnowflake(Snowflake.id)

This method only operates on data in memory.

Returns: Date


Methods

delete()

Permanently deletes the sticker. This cannot be undone!

This method always makes an HTTP request.

Returns: boolean


setDescription(description)

Parameter Type
description string

Sets the stickers's description. The description must be between 2 and 30 characters in length.

This method always makes an HTTP request.

Returns: boolean


setName(name)

Parameter Type
name string

Sets the stickers's name. The name must be between 2 and 30 characters in length.

This method always makes an HTTP request.

Returns: boolean


setTags(tags)

Parameter Type
tags string

Sets the stickers's tags. The tags can only be up to 200 characters long.

This method always makes an HTTP request.

Returns: boolean


Clone this wiki locally