Class BotChannelsController

Provides an interface for the bot's channels cache. The channels are mapped by their IDs

Hierarchy

BaseFetchController<Channel>
- BotChannelsController

Implements

BaseDeleteController<Channel>

Index

Constructors

constructor

Properties

cache

Methods

Constructors

constructor

new BotChannelsController(struct: BaseStruct | Bot, limit?: undefined | number): BotChannelsController

Inherited from BaseController.constructor
- Defined in src/controllers/base/BaseController.ts:18
Parameters
- struct: BaseStruct | Bot
- Optional limit: undefined | number
Returns BotChannelsController

Properties

cache

cache: ControllerCache<Channel>

The cached data this controller contains

Methods

delete

delete(id: Snowflake): Promise<void | Channel>

- Defined in src/controllers/bot/BotChannelsController.ts:22
Deletes a channel

Parameters
- id: Snowflake
  
  The ID of the channel you wish to delete
Returns Promise<void | Channel>

fetch

fetch(id: Snowflake): Promise<Channel>

Overrides BaseFetchController.fetch
- Defined in src/controllers/bot/BotChannelsController.ts:31
Fetches a channel

Parameters
- id: Snowflake
  
  The ID of the channel you wish to fetch
Returns Promise<Channel>

get

get(id: Snowflake): Promise<Channel>

Overrides BaseFetchController.get
- Defined in src/controllers/bot/BotChannelsController.ts:36
inheritdoc

Parameters
- id: Snowflake
Returns Promise<Channel>

getGuildChannel

getGuildChannel(id: Snowflake): Promise<GuildChannel>

- Defined in src/controllers/bot/BotChannelsController.ts:68
Gets or fetches a guild channel by its ID

Parameters
- id: Snowflake
  
  The ID of the text channel
Returns Promise<GuildChannel>

getText

getText(id: Snowflake): Promise<TextBasedChannel>

- Defined in src/controllers/bot/BotChannelsController.ts:53
Gets or fetches a text channel by its ID

Parameters
- id: Snowflake
  
  The ID of the text channel
Returns Promise<TextBasedChannel>

Generated using TypeDoc