Class Channel

Represents a channel within Discord.

See

https://discord.com/developers/docs/resources/channel

Hierarchy (View Summary)

Channel

Implements

GuildChannel

Index

Constructors

constructor

new Channel(
    client: Client,
    data:
        | GuildChannelCacheJSON
        | GuildChannelDiscordJSON
        | GuildChannelStorageJSON
        | APIGuildTextChannel<GuildTextChannelType>
        | APIGuildTextChannel<GuildForum>
        | APIGuildTextChannel<GuildMedia>
        | APIGuildVoiceChannel,
    options: { guildId: string },
): Channel
Creates the base structure for a channel.
Parameters
- client: Client
  The client instance.
- data:
      | GuildChannelCacheJSON
      | GuildChannelDiscordJSON
      | GuildChannelStorageJSON
      | APIGuildTextChannel<GuildTextChannelType>
      | APIGuildTextChannel<GuildForum>
      | APIGuildTextChannel<GuildMedia>
      | APIGuildVoiceChannel
  Raw channel data.
- options: { guildId: string }
  Additional options for this structure.
  - guildId: string
    The ID of the guild that this channel belongs to.
Returns Channel
See
https://discord.com/developers/docs/resources/channel#channel-object-channel-structure
- Defined in src/structures/GuildChannel.ts:68

Accessors

_cacheOptions

get _cacheOptions(): ChannelCacheOptions
The cache options for this channel.

Returns ChannelCacheOptions
Implementation of GuildChannelType._cacheOptions
- Defined in src/structures/GuildChannel.ts:426

guild

get guild(): null | Guild
The guild that this channel belongs to.

Returns null | Guild
Implementation of GuildChannelType.guild
- Defined in src/structures/GuildChannel.ts:314

guildId

get guildId(): string
The ID of the guild that this channel belongs to.

Returns string
Implementation of GuildChannelType.guildId
- Defined in src/structures/GuildChannel.ts:346

id

get id(): string
The ID of the channel.

Returns string
Implementation of GuildChannelType.id
- Defined in src/structures/GuildChannel.ts:336

mention

get mention(): string
Returns the mention for this channel.

Returns string
Implementation of GuildChannelType.mention
- Defined in src/structures/GuildChannel.ts:294

messages

get messages(): ChannelMessageManager
The messages in this channel.

Returns ChannelMessageManager
Implementation of GuildChannelType.messages
- Defined in src/structures/GuildChannel.ts:436

name

get name(): string
The name of the channel.

Returns string
Implementation of GuildChannelType.name
- Defined in src/structures/GuildChannel.ts:376

nsfw

get nsfw(): boolean
Whether this channel is marked as NSFW or not.

Returns boolean
Implementation of GuildChannelType.nsfw
- Defined in src/structures/GuildChannel.ts:304

parent

get parent(): null | AllChannels
The parent channel.

Returns null | AllChannels
Implementation of GuildChannelType.parent
- Defined in src/structures/GuildChannel.ts:324

parentId

get parentId(): null | string
The ID of the parent channel.

Returns null | string
Implementation of GuildChannelType.parentId
- Defined in src/structures/GuildChannel.ts:356

permissionOverwrites

get permissionOverwrites(): PermissionOverwrite[]
The permission overwrites for this channel.

Returns PermissionOverwrite[]
Implementation of GuildChannelType.permissionOverwrites
- Defined in src/structures/GuildChannel.ts:396

position

get position(): undefined | number
The position of the channel.

Returns undefined | number
Implementation of GuildChannelType.position
- Defined in src/structures/GuildChannel.ts:416

rateLimitPerUser

get rateLimitPerUser(): undefined | number
The message send cooldown for the channel.

Returns undefined | number
Implementation of GuildChannelType.rateLimitPerUser
- Defined in src/structures/GuildChannel.ts:406

topic

get topic(): null | string
The topic of the channel.

Returns null | string
Implementation of GuildChannelType.topic
- Defined in src/structures/GuildChannel.ts:386

type

get type(): ChannelType
The type of channel.

Returns ChannelType
Implementation of GuildChannelType.type
- Defined in src/structures/GuildChannel.ts:366

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/GuildChannel.ts:593

checkPermission

checkPermission(member: Member): string
Returns the permissions for a member in this channel.
Parameters
- member: Member
  The member to check the permissions for.
Returns string
Implementation of GuildChannelType.checkPermission
- Defined in src/structures/GuildChannel.ts:542

send

send(
    data?: {
        components?: MessageComponents;
        content?: string;
        embeds?: Embed[];
        files?: FileUpload[];
        suppressMentions?: boolean;
    },
): Promise<Message>
Sends a message to this channel.
Parameters
- Optionaldata: {
      components?: MessageComponents;
      content?: string;
      embeds?: Embed[];
      files?: FileUpload[];
      suppressMentions?: boolean;
  }
  Embeds, components and files to include with the message.
  - Optionalcomponents?: MessageComponents
    The components to include with the message.
  - Optionalcontent?: string
    The content of the message.
  - Optionalembeds?: Embed[]
    The embeds to include with the message.
  - Optionalfiles?: FileUpload[]
    The files to include with the message.
  - OptionalsuppressMentions?: boolean
    Whether to suppress mentions in the message.
Returns Promise<Message>
See
https://discord.com/developers/docs/resources/channel#create-message

Method
Async
Throws
Implementation of GuildChannelType.send
- Defined in src/structures/GuildChannel.ts:266

toJSON

toJSON(
format?: JsonTypes,
): GuildChannelCacheJSON | GuildChannelDiscordJSON | GuildChannelStorageJSON
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns GuildChannelCacheJSON | GuildChannelDiscordJSON | GuildChannelStorageJSON
Method
Implementation of GuildChannelType.toJSON
- Defined in src/structures/GuildChannel.ts:604

toString

toString(): string
Returns string
Method
Implementation of GuildChannelType.toString
- Defined in src/structures/GuildChannel.ts:585

`Static`fetchWebhooks

fetchWebhooks(client: Client, channelId: string): Promise<APIWebhook[]>
Returns an array of webhooks for the specified channel.
Parameters
- client: Client
  The client instance.
- channelId: string
  The ID of the channel.
Returns Promise<APIWebhook[]>
Static
Async
Method
- Defined in src/structures/GuildChannel.ts:525

`Static`follow

follow(
    client: Client,
    channelId: string,
    followChannelId: string,
): Promise<void>
Follows a news channel.
Parameters
- client: Client
  The client instance.
- channelId: string
  The ID of the channel.
- followChannelId: string
  THe ID of the channel to follow.
Returns Promise<void>
Static
Async
Method
Throws
- Defined in src/structures/GuildChannel.ts:491

`Static`getMention

getMention(channelId: string): string
Returns the mention string for a channel.
Parameters
- channelId: string
  The ID of the channel to mention.
Returns string
Static
Method
- Defined in src/structures/GuildChannel.ts:448

`Static`shouldCache

shouldCache(
gluonCacheOptions: GluonCacheOptions,
guildCacheOptions: GuildCacheOptions,
): boolean
Determines whether the channel should be cached.
Parameters
- gluonCacheOptions: GluonCacheOptions
  The cache options for the client.
- guildCacheOptions: GuildCacheOptions
  The cache options for the guild.
Returns boolean
Static
Method
- Defined in src/structures/GuildChannel.ts:462

Class Channel

See

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

guildId: string

Returns Channel

See

Accessors

_cacheOptions

Returns ChannelCacheOptions

guild

Returns null | Guild

guildId

Returns string

id

Returns string

mention

Returns string

messages

Returns ChannelMessageManager

name

Returns string

nsfw

Returns boolean

parent

Returns null | AllChannels

parentId

Returns null | string

permissionOverwrites

Returns PermissionOverwrite[]

position

Returns undefined | number

rateLimitPerUser

Returns undefined | number

topic

Returns null | string

type

Returns ChannelType

Methods

[custom]

Returns string

Method

checkPermission

Parameters

Returns string

send

Parameters

Optionalcomponents?: MessageComponents

Optionalcontent?: string

Optionalembeds?: Embed[]

Optionalfiles?: FileUpload[]

OptionalsuppressMentions?: boolean

Returns Promise<Message>

See

Method

Async

Throws

toJSON

Parameters

Returns GuildChannelCacheJSON | GuildChannelDiscordJSON | GuildChannelStorageJSON

Method

toString

Returns string

Method

StaticfetchWebhooks

Parameters

Returns Promise<APIWebhook[]>

Static

Async

Method

Staticfollow

Parameters

Returns Promise<void>

`Optional`components?: MessageComponents

`Optional`content?: string

`Optional`embeds?: Embed[]

`Optional`files?: FileUpload[]

`Optional`suppressMentions?: boolean

`Static`fetchWebhooks

`Static`follow

`Static`getMention

`Static`shouldCache