GuildEmoji | node-discord

Structure for Emojis that were created in a Guild

Hierarchy

Emoji
- GuildEmoji

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GuildEmoji(bot: Bot, emoji: GatewayStruct, guild: Guild): GuildEmoji

Overrides Emoji.constructor
- Defined in src/structures/guild/GuildEmoji.ts:57
Parameters
- bot: Bot
- emoji: GatewayStruct
- guild: Guild
Returns GuildEmoji

Properties

animated

animated: boolean | undefined

Whether this emoji is animated

available

available: boolean | undefined

Whether this emoji can be used, may be false due to loss of Server Boosts

bot

bot: Bot

The Bot operating this structure

emojiId

emojiId: Snowflake | null

The ID of the emoji. Possibly null if the emoji class was generated from a standard emoji

guild

guild: Guild

Every guild emoji is associated to a guild

managed

managed: boolean | undefined

Whether this emoji is managed

name

name: string

Every guild emoji has a name

requiresColons

requiresColons: boolean | undefined

Whether this emoji must be wrapped in colons

roles

roles: Collection<Snowflake, Role> | undefined

Collection of Roles this emoji is whitelisted to

user

user: User | undefined

The user that created this emoji

Accessors

id

get id(): string

Overrides Emoji.id
- Defined in src/structures/guild/GuildEmoji.ts:66
Every guild emoji has an identifier

Returns string

Methods

URL

URL(format?: GuildEmojiFormat, size?: undefined | number): string

- Defined in src/structures/guild/GuildEmoji.ts:76
Returns the guild emoji's URL

Parameters
- Default value format: GuildEmojiFormat = GuildEmojiFormat.PNG
  
  The format of the returned emoji image
- Optional size: undefined | number
  
  The size of the returned emoji image
Returns string

clone

clone(): this

Inherited from BaseStruct.clone
- Defined in src/structures/base/BaseStruct.ts:55
Clone a structure

Returns this

delete

delete(): Promise<void>

- Defined in src/structures/guild/GuildEmoji.ts:95
Deletes this emoji. Requires the Permission.ManageEmojis permission

Returns Promise<void>

modify

modify(options: ModifyEmojiOptions): Promise<GuildEmoji>

- Defined in src/structures/guild/GuildEmoji.ts:86
Modifies this emoji. Requires the Permission.ManageEmojis permission

Parameters
- options: ModifyEmojiOptions
  
  The options for the updated emoji
Returns Promise<GuildEmoji>

update

update(data: GatewayStruct): UpdateReturn<this>

Inherited from BaseStruct.update
- Defined in src/structures/base/BaseStruct.ts:64
Update a structure and return its before and after versions

Parameters
- data: GatewayStruct
  
  The updated data
Returns UpdateReturn<this>

Static resolve

resolve(emojis: Collection<Snowflake, Emoji>, emoji: EmojiResolvable): string | null

Inherited from Emoji.resolve
- Defined in src/structures/Emoji.ts:110
Finds the identifier of the given emoji. The emoji can be a Guild emoji, meaning we would have to search for it in the Bot's cached emojis Collection

Parameters
- emojis: Collection<Snowflake, Emoji>
  
  An emojis cache to search for the emoji in
- emoji: EmojiResolvable
  
  The emoji to resolve
Returns string | null

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

bot: Bot

emoji: GatewayStruct

guild: Guild

Returns GuildEmoji

Properties

animated

available

bot

emojiId

guild

managed

name

requiresColons

roles

user

Accessors

id

Returns string

Methods

URL

Parameters

Default value format: GuildEmojiFormat = GuildEmojiFormat.PNG

Optional size: undefined | number

Returns string

clone

Returns this

delete

Returns Promise<void>

modify

Parameters

options: ModifyEmojiOptions

Returns Promise<GuildEmoji>

update

Parameters

data: GatewayStruct

Returns UpdateReturn<this>

Static resolve

Parameters

emojis: Collection<Snowflake, Emoji>

emoji: EmojiResolvable

Returns string | null