Class ChannelUtils

Handles channel-related util methods

Hierarchy

ChannelUtils

Index

Methods

Methods

Static cache

cache(bot: Bot, channel: Channel, force?: boolean): void

- Defined in src/structures/channels/utils/ChannelUtils.ts:99
Caches a channel in the correct Collection

Parameters
- bot: Bot
  
  The bot instance
- channel: Channel
  
  The channel you wish to cache
- Default value force: boolean = false
  
  Whether or not to force cache DM channels if already cached
Returns void

Static create

create(bot: Bot, data: GatewayStruct, guild_?: Guild): Promise<Channel>

- Defined in src/structures/channels/utils/ChannelUtils.ts:21
Creates a new Channel instance, initialized relatively to its type

Parameters
- bot: Bot
  
  The bot instance
- data: GatewayStruct
  
  The channel data received from the gateway
- Optional guild_: Guild
  
  The guild associated to the channel
Returns Promise<Channel>

Static createDMChannel

createDMChannel(bot: Bot, data: GatewayStruct): DMChannel

- Defined in src/structures/channels/utils/ChannelUtils.ts:67
Creates a new DMChannel instance

Parameters
- bot: Bot
  
  The bot instance
- data: GatewayStruct
  
  The channel data received from the gateway
Returns DMChannel

Static createGuildChannel

createGuildChannel(bot: Bot, data: GatewayStruct, guild: Guild): GuildChannel

- Defined in src/structures/channels/utils/ChannelUtils.ts:38
Creates a new GuildChannel instance, initialized relatively to its type

Parameters
- bot: Bot
  
  The bot instance
- data: GatewayStruct
  
  The channel data received from the gateway
- guild: Guild
  
  The guild associated to the channel
Returns GuildChannel

Static delete

delete(bot: Bot, channel: Channel): void

- Defined in src/structures/channels/utils/ChannelUtils.ts:124
Deletes a channel from the cache

Parameters
- bot: Bot
  
  The bot instance
- channel: Channel
  
  The channel you wish to delete
Returns void

Static getChannelGuild

getChannelGuild(bot: Bot, channel: Channel | GatewayStruct): Promise<Guild>

- Defined in src/structures/channels/utils/ChannelUtils.ts:83
Retrieves the guild hidden in a channel instance's structure

Parameters
- bot: Bot
  
  The bot instance
- channel: Channel | GatewayStruct
  
  The channel instance
Returns Promise<Guild>

Generated using TypeDoc