Class Channel<T>

see: https://discord.com/developers/docs/resources/channel#channel-object

Type parameters

T

Hierarchy

Structure
- Channel
  - GuildChannel
  - DMChannel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Channel(client: Client, data: APIChannelPartial): Channel

Overrides Structure.constructor
- Defined in src/lib/caching/structures/channels/Channel.ts:28
Parameters
- client: Client
- data: APIChannelPartial
Returns Channel

Properties

Readonly client

client: T

deleted

deleted: boolean = false

Whether the DM channel is deleted.

since: 0.0.1

Readonly id

id: string

The ID of this channel.

since: 0.0.1

Readonly Abstract type

type: ChannelType

The type of channel.

since: 0.0.1
see: https://discord.com/developers/docs/resources/channel#channel-object-channel-types

Static Private Readonly types

types: Map<ChannelType, "Ban" | "CategoryChannel" | "Channel" | "ClientUser" | "DMChannel" | "Guild" | "GuildChannel" | "GuildEmoji" | "GuildMember" | "Integration" | "Invite" | "Message" | "MessageReaction" | "NewsChannel" | "Overwrite" | "Presence" | "Role" | "StoreChannel" | "Team" | "TeamMember" | "TextChannel" | "User" | "VoiceChannel" | "VoiceState"> = new Map<ChannelType, keyof ExtenderStructures>([[ChannelType.GuildText, 'TextChannel'],[ChannelType.DM, 'DMChannel'],[ChannelType.GuildVoice, 'VoiceChannel'],[ChannelType.GroupDM, 'Channel'],[ChannelType.GuildCategory, 'CategoryChannel'],[ChannelType.GuildNews, 'NewsChannel'],[ChannelType.GuildStore, 'StoreChannel']])

Accessors

createdAt

get createdAt(): Date

Inherited from Structure.createdAt
- Defined in src/lib/caching/structures/base/Structure.ts:20
The Date when this object was created at

Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from Structure.createdTimestamp
- Defined in src/lib/caching/structures/base/Structure.ts:27
The time when this object was created at

Returns number

Methods

Protected Abstract _patch

_patch(data: unknown): this

Inherited from Structure._patch
- Defined in src/lib/caching/structures/base/Structure.ts:42
The method of patching this instance defined in Structures

Parameters
- data: unknown
  
  The data packet
Returns this

clone

clone(): this

Inherited from Structure.clone
- Defined in src/lib/caching/structures/base/Structure.ts:34
Basic clone method

Returns this

toJSON

toJSON(): Record<string, any>

Inherited from Structure.toJSON
- Defined in src/lib/caching/structures/base/Structure.ts:54
The JSON representation of this object.

Returns Record<string, any>

toString

toString(): string

- Defined in src/lib/caching/structures/channels/Channel.ts:40
Defines toString behavior for channels.

since

0.0.1

Returns string

valueOf

valueOf(): string

Inherited from Structure.valueOf
- Defined in src/lib/caching/structures/base/Structure.ts:47
The basic value of this Structure

Returns string

Static create

create(client: Client, data: APIChannelData, ...extra: keyof unknown[]): Channel | null

- Defined in src/lib/caching/structures/channels/Channel.ts:44
Parameters
- client: Client
- data: APIChannelData
- Rest ...extra: keyof unknown[]
Returns Channel | null

Generated using TypeDoc