Class GuildEmojisController

Provides an interface for a guild's emojis cache. The emojis are mapped by their IDs

Hierarchy

BaseFetchController<GuildEmoji>
- GuildEmojisController

Implements

Index

Constructors

constructor

Properties

cache
guild

Methods

Constructors

constructor

new GuildEmojisController(guild: Guild): GuildEmojisController

Overrides BaseController.constructor
- Defined in src/controllers/guild/GuildEmojisController.ts:17
Parameters
- guild: Guild
Returns GuildEmojisController

Properties

cache

cache: ControllerCache<GuildEmoji>

The cached data this controller contains

Readonly guild

guild: Guild

The guild associated to this controller

Methods

create

create(options: CreateEmojiOptions): Promise<GuildEmoji>

- Defined in src/controllers/guild/GuildEmojisController.ts:30
Creates a new guild emoji

Parameters
- options: CreateEmojiOptions
  
  The options for the new guild emoji
Returns Promise<GuildEmoji>

fetch

fetch(id: Snowflake): Promise<GuildEmoji>

Overrides BaseFetchController.fetch
- Defined in src/controllers/guild/GuildEmojisController.ts:39
Fetches a guild emoji by its ID

Parameters
- id: Snowflake
  
  The ID of the guild emoji
Returns Promise<GuildEmoji>

fetchAll

fetchAll(): Promise<Collection<Snowflake, GuildEmoji>>

- Defined in src/controllers/guild/GuildEmojisController.ts:51
Fetches all emojis in a guild

Returns Promise<Collection<Snowflake, GuildEmoji>>

get

get(id: Snowflake | string): Promise<GuildEmoji>

Inherited from BaseFetchController.get
- Defined in src/controllers/base/BaseFetchController.ts:22
Returns an already cached item or fetches it

Parameters
- id: Snowflake | string
  
  The ID of the item you wish to get or fetch
Returns Promise<GuildEmoji>

Generated using TypeDoc