Results

Namespace

Type

A class wrapper around emoji data. Can represent a unicode or custom emoji.

Hierarchy

  • Emoji <-- You are here!

Implements

Index

Type aliases

Static AnyEmoji

A type union of all possible emoji types.

Properties

Readonly animated

animated: boolean

If true, this emoji is animated.

Readonly id

id: Snowflake | null

Discord's unique identifier for this emoji.

If null, the emoji is a unicode emoji and will only have the name and type property set.

Readonly managed

managed: boolean

If true, this emoji is managed by an integration and you cannot modify it.

Readonly name

name: string

The custom name for this emoji, if it's a guild emoji.

Otherwise, the name is the literal emoji character(s). Example: 🎉

Readonly requireColons

requireColons: boolean

If true (default), the emoji requires colons. You cannot change this field.

Readonly roles

If not empty, the roles in this array have access to the emoji.

Readonly type

type: Type

The type of emoji this is.

Readonly user

user: User | null

The user who uploaded the emoji.

Methods

delete

  • delete(): Promise<void>
  • Deletes the emoji from this guild.

    Returns Promise<void>

edit

  • edit(options: IEditEmojiOptions): Promise<Emoji>
  • Edits the emoji's options. You can't change the emoji's image, but the name and role list may be updated.

    Returns the new emoji data on success.

    Parameters

    Returns Promise<Emoji>

toMention

  • toMention(): string
  • Returns string

    A message-ready string representation of the emoji.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc