Class GuildChannel

Represents a guild channel.

Hierarchy

Channel
- GuildChannel

Index

Constructors

constructor

new GuildChannel(data, client): GuildChannel
Parameters
- data: RawGuildChannel
- client: Client<ClientEvents>
Returns GuildChannel
Overrides Channel.constructor
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/GuildChannel.d.ts:22

Properties

`Private` `Optional` _cachedGuild

_cachedGuild?: any

`Private` `Optional` _cachedParent

_cachedParent?: any

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

The type of this channel.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Channel.createdAt
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:15

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 node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/GuildChannel.d.ts:25

mention

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

Returns string
Inherited from Channel.mention
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Channel.d.ts:14

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 node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/GuildChannel.d.ts:27

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 node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Channel.d.ts:18

edit

edit(options): Promise<GuildChannel>
Edit this channel.
Parameters
- options: EditAnnouncementChannelOptions | EditPublicThreadChannelOptions | EditAnyGuildChannelOptions | EditForumChannelOptions | EditTextChannelOptions | EditVoiceChannelOptions | EditPrivateThreadChannelOptions | EditStageChannelOptions
  
  The options for editing the channel.
Returns Promise<GuildChannel>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/GuildChannel.d.ts:32

toJSON

toJSON(): JSONGuildChannel
Returns JSONGuildChannel
Overrides Channel.toJSON
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/GuildChannel.d.ts:33

toString

toString(): string
Returns string
Inherited from Channel.toString
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:19

`Protected` update

update(data): void
Parameters
- data: Partial<RawGuildChannel>
Returns void
Overrides Channel.update
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/GuildChannel.d.ts:23

`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 node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Channel.d.ts:12

`Static` generateID

generateID(timestamp?): string
Parameters
- Optional timestamp: number | Date
Returns string
Inherited from Channel.generateID
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:11

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Channel.getCreatedAt
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:12

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Channel.getDiscordEpoch
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:13

Class GuildChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawGuildChannel

client: Client<ClientEvents>

Returns GuildChannel

Properties

Private Optional _cachedGuild

Private Optional _cachedParent

client

guildID

id

name

parentID

type

Accessors

createdAt

Returns Date

guild

Returns Guild

mention

Returns string

parent

Returns undefined | null | TextChannel | CategoryChannel | AnnouncementChannel | ForumChannel

Methods

delete

Returns Promise<void>

edit

Parameters

options: EditAnnouncementChannelOptions | EditPublicThreadChannelOptions | EditAnyGuildChannelOptions | EditForumChannelOptions | EditTextChannelOptions | EditVoiceChannelOptions | EditPrivateThreadChannelOptions | EditStageChannelOptions

Returns Promise<GuildChannel>

toJSON

Returns JSONGuildChannel

toString

Returns string

Protected update

Parameters

data: Partial<RawGuildChannel>

Returns void

Static from

Type Parameters

T extends AnyChannel = AnyChannel

Parameters

data: RawChannel

client: Client<ClientEvents>

Returns T

Static generateID

Parameters

Optional timestamp: number | Date

Returns string

Static getCreatedAt

Parameters

id: string

Returns Date

Static getDiscordEpoch

Parameters

id: string

Returns number

Settings

Member Visibility

Theme

On This Page

`Private` `Optional` _cachedGuild

`Private` `Optional` _cachedParent

`Protected` update

`Static` from

`Static` generateID

`Optional` timestamp: number | Date

`Static` getCreatedAt

`Static` getDiscordEpoch