Class GuildChannel

Represents a guild channel.

Hierarchy (view full)

Channel
- GuildChannel

Index

Constructors

Properties

client guildID id name parentID type

Accessors

createdAt guild mention parent

Methods

delete edit toJSON toString from generateID getCreatedAt getDiscordEpoch

Constructors

constructor

new GuildChannel(data, client): GuildChannel
Parameters
- data: RawGuildChannel
- client: Client<ClientEvents>
Returns GuildChannel
Overrides Channel.constructor
- Defined in lib/structures/GuildChannel.ts:25

Properties

client

client: Client<ClientEvents>

guildID

guildID: string

The id of the guild this channel is in.

id

id: string

name

name: string

The name of this channel.

parentID

parentID: null | string

The ID of the parent of this channel, if applicable.

type

type: GUILD_TEXT | GUILD_VOICE | GUILD_CATEGORY | GUILD_ANNOUNCEMENT | ANNOUNCEMENT_THREAD | PUBLIC_THREAD | PRIVATE_THREAD | GUILD_STAGE_VOICE | GUILD_DIRECTORY | GUILD_FORUM | GUILD_MEDIA

The type of this channel.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Channel.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): Guild
The guild associated with this channel. This will throw an error if the guild is not cached.

Returns Guild
- Defined in lib/structures/GuildChannel.ts:46

mention

get mention(): string
A string that will mention this channel.

Returns string
Inherited from Channel.mention
- Defined in lib/structures/Channel.ts:77

parent

get parent(): undefined | null | TextChannel | CategoryChannel | AnnouncementChannel | ForumChannel
The parent of this channel, if applicable. This will be a text/announcement/forum channel if we're in a thread, category otherwise.

Returns undefined | null | TextChannel | CategoryChannel | AnnouncementChannel | ForumChannel
- Defined in lib/structures/GuildChannel.ts:64

Methods

delete

delete(): Promise<void>
Close a direct message, leave a group channel, or delete a guild channel.

Returns Promise<void>
Inherited from Channel.delete
- Defined in lib/structures/Channel.ts:84

edit

edit(options): Promise<GuildChannel>
Edit this channel.
Parameters
- options: EditTextChannelOptions | EditAnyGuildChannelOptions | EditVoiceChannelOptions | EditAnnouncementChannelOptions | EditPublicThreadChannelOptions | EditPrivateThreadChannelOptions | EditStageChannelOptions | EditForumChannelOptions | EditMediaChannelOptions
  The options for editing the channel.
Returns Promise<GuildChannel>
- Defined in lib/structures/GuildChannel.ts:76

toJSON

toJSON(): JSONGuildChannel
Returns JSONGuildChannel
Overrides Channel.toJSON
- Defined in lib/structures/GuildChannel.ts:81

toString

toString(): string
Returns string
Inherited from Channel.toString
- Defined in lib/structures/Base.ts:64

`Static` from

from<T>(data, client): T
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- data: RawChannel
- client: Client<ClientEvents>
Returns T
Inherited from Channel.from
- Defined in lib/structures/Channel.ts:32

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Channel.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Channel.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Channel.getDiscordEpoch
- Defined in lib/structures/Base.ts:32