gluon
    Preparing search index...

    Class Emoji

    Represents an emoji.

    https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure

    Implements

    • Emoji
    Index

    Constructors

    constructor

    Accessors

    animated available guild guildId id managed mention name requireColons url

    Methods

    [custom] toJSON toString getMention getUrl isAnimated shouldCache

    Constructors

    • Creates the structure for an emoji.

      Parameters

      • client: Client

        The client instance.

      • data: EmojiStorageJSON | EmojiCacheJSON | APIEmoji | EmojiDiscordJSON

        The raw emoji data from Discord.

      • options: { guildId: string; nocache?: boolean }

        The options for this emoji.

        • guildId: string

          The id of the guild that the emoji belongs to.

        • Optionalnocache?: boolean

          Whether this emoji should be cached or not.

      Returns Emoji

    Accessors

    • get animated(): boolean

      Whether the emoji is animated.

      Returns boolean

    • get available(): boolean

      Whether the emoji is available.

      Returns boolean

    • get guild(): null | Guild

      The guild that this emoji belongs to.

      Returns null | Guild

    • get guildId(): string

      The id of the guild that this emoji belongs to.

      Returns string

    • get id(): null | string

      The id of the emoji, if it is custom.

      Returns null | string

    • get managed(): boolean

      Whether the emoji is managed.

      Returns boolean

    • get mention(): string

      The mention string for the emoji.

      Returns string

    • get name(): null | string

      The name of the emoji.

      Returns null | string

    • get requireColons(): boolean

      Whether the emoji requires colons.

      Returns boolean

    • get url(): null | string

      The url for the emoji.

      Returns null | string

    Methods

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns EmojiStorageJSON | EmojiCacheJSON | EmojiDiscordJSON

    • Returns the mention string for an emoji.

      Parameters

      • name: string

        The name of the emoji.

      • id: null | string

        The id of the emoji.

      • Optionalanimated: boolean

        Whether the emoji is animated.

      Returns string

    • Returns the url for an emoji.

      Parameters

      • id: string

        The id of the emoji.

      • Optionalanimated: boolean = false

        Whether the emoji is animated.

      Returns string

    • Checks if the emoji is animated.

      Parameters

      • attributes: number

        The attributes of the emoji.

      Returns boolean

    • Determines whether the emoji should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods