Class Channel

Represents a guild or DM channel within Discord.

Hierarchy

BaseStruct
- Channel
  - GuildChannel
  - DMChannel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Channel(bot: Bot, channel: GatewayStruct): Channel

Overrides BaseStruct.constructor
- Defined in src/structures/channels/Channel.ts:30
Parameters
- bot: Bot
- channel: GatewayStruct
Returns Channel

Properties

bot

bot: Bot

The Bot operating this structure

id

The ID of this channel

type

type: ChannelType

The type of this channel

Methods

clone

clone(): this

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

Returns this

delete

delete(): Promise<Channel>

- Defined in src/structures/channels/Channel.ts:54
Deletes a GuildChannel, or closes a DMChannel. Requires the Permission.ManageChannels permission for the guild

Returns Promise<Channel>

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>

Generated using TypeDoc