Class GuildChannelsController

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

Hierarchy

BaseFetchController<GuildChannel>
- GuildChannelsController

Implements

Index

Constructors

constructor

Properties

cache
guild

Methods

Constructors

constructor

new GuildChannelsController(guild: Guild): GuildChannelsController

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

Properties

cache

cache: ControllerCache<GuildChannel>

The cached data this controller contains

Readonly guild

guild: Guild

The guild this controller is associated to

Methods

create

create(options: CreateGuildChannelOptions): Promise<GuildChannel>

- Defined in src/controllers/guild/GuildChannelsController.ts:58
Creates a new guild channel in the guild associated to this controller. Requires the Permission.ManageChannels

Parameters
- options: CreateGuildChannelOptions
  
  The options for the new guild channel
Returns Promise<GuildChannel>

delete

delete(id: Snowflake): Promise<GuildChannel>

- Defined in src/controllers/guild/GuildChannelsController.ts:67
Deletes a guild channel

Parameters
- id: Snowflake
  
  The ID of the guild channel you wish to delete
Returns Promise<GuildChannel>

fetch

fetch(id: Snowflake): Promise<GuildChannel>

Overrides BaseFetchController.fetch
- Defined in src/controllers/guild/GuildChannelsController.ts:76
Fetches a guild channel

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

fetchAll

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

- Defined in src/controllers/guild/GuildChannelsController.ts:89
Fetches and caches all channels the guild associated to this controller

Returns Promise<Collection<Snowflake, GuildChannel>>

get

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

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<GuildChannel>

getText

getText(id: Snowflake): Promise<GuildTextChannel>

- Defined in src/controllers/guild/GuildChannelsController.ts:42
Gets or fetches a guild text channel by its ID

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

modifyPositions

modifyPositions(positions: Positions): Promise<void>

- Defined in src/controllers/guild/GuildChannelsController.ts:115
Modifies the positions of a set of channels for the guild. Requires the Permission.ManageChannels permission

Parameters
- positions: Positions
  
  The new positions for the guild channels
Returns Promise<void>

swap

swap(channel1: GuildChannel, channel2: GuildChannel): Promise<void>

- Defined in src/controllers/guild/GuildChannelsController.ts:103
Swaps the positions of 2 guild channels with one another

Parameters
- channel1: GuildChannel
  
  The first guild channel
- channel2: GuildChannel
  
  The second guild channel
Returns Promise<void>

Generated using TypeDoc