Class GuildChannel<T>

Type parameters

T: APIGuildChannel<GuildChannelType> = APIGuildChannel<GuildChannelType>

Hierarchy

Channel<T>
- GuildChannel
  - BaseTextChannelInGuild

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GuildChannel<T>(client: Client, data?: T): GuildChannel<T>

Inherited from Channel.constructor
- Defined in src/structures/templates/BaseStructure.ts:16
Type parameters
- T: APIGuildChannel<GuildChannelType, T> = APIGuildChannel<GuildChannelType>
Parameters
- client: Client
- Optional data: T
Returns GuildChannel<T>

Properties

client

client: Client

guildId

guildId: null | string = null

id

id: string

name

name: string = ''

nsfw

nsfw: boolean = false

parentId

parentId: null | string = null

position

position: number = 0

type

type: ChannelType = ChannelType.GuildCategory

Accessors

children

get children(): GuildChannels[]

- Defined in src/structures/GuildChannel.ts:23
Returns GuildChannels[]

createdAt

get createdAt(): Date

Inherited from Channel.createdAt
- Defined in src/structures/templates/BaseStructure.ts:12
Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from Channel.createdTimestamp
- Defined in src/structures/templates/BaseStructure.ts:9
Returns number

delete

get delete(): (...args: [reason?: string]) => Promise<void>

- Defined in src/structures/GuildChannel.ts:93
Returns (...args: [reason?: string]) => Promise<void>
- - (...args: [reason?: string]): Promise<void>
  - Parameters
    - Rest ...args: [reason?: string]
    Returns Promise<void>

guild

get guild(): null | Guild

Inherited from Channel.guild
- Defined in src/structures/Channel.ts:23
Returns null | Guild

parent

get parent(): undefined | GuildChannels

- Defined in src/structures/GuildChannel.ts:19
Returns undefined | GuildChannels

Methods

_deserialise

_deserialise(data: T): GuildChannel<T>

Overrides Channel._deserialise
- Defined in src/structures/GuildChannel.ts:29
Parameters
- data: T
Returns GuildChannel<T>

_set_guild

_set_guild(id: string): GuildChannel<T>

Inherited from Channel._set_guild
- Defined in src/structures/Channel.ts:35
Parameters
- id: string
Returns GuildChannel<T>

fetch

fetch(): Promise<GuildChannel<T>>

Inherited from Channel.fetch
- Defined in src/structures/Channel.ts:81
Returns Promise<GuildChannel<T>>

setName

setName(name: string): Promise<GuildChannel<T>>

- Defined in src/structures/GuildChannel.ts:73
Parameters
- name: string
Returns Promise<GuildChannel<T>>

setNsfw

setNsfw(nsfw: boolean): Promise<GuildChannel<T>>

- Defined in src/structures/GuildChannel.ts:81
Parameters
- nsfw: boolean
Returns Promise<GuildChannel<T>>

setParent

setParent(parent: string | GuildChannels): void

- Defined in src/structures/GuildChannel.ts:85
Parameters
- parent: string | GuildChannels
Returns void

setPosition

setPosition(position: number): Promise<GuildChannel<T>>

- Defined in src/structures/GuildChannel.ts:77
Parameters
- position: number
Returns Promise<GuildChannel<T>>

toJSON

toJSON(): T

Overrides Channel.toJSON
- Defined in src/structures/GuildChannel.ts:97
Returns T

Static create

create(client: Client, data: APIChannelBase<ChannelType> & { guild_id?: string }): Channels<DMChannel | GuildChannels | Channel<APIChannel>, APIChannel>

Inherited from Channel.create
- Defined in src/structures/Channel.ts:40
Parameters
- client: Client
- data: APIChannelBase<ChannelType> & { guild_id?: string }
Returns Channels<DMChannel | GuildChannels | Channel<APIChannel>, APIChannel>

Static resolve

resolve(client: Client, data: APIGuildChannel<GuildChannelType>, guild: Guild): GuildChannels

- Defined in src/structures/GuildChannel.ts:43
Creates a type-strong version of the channel, based on its type.

Parameters
- client: Client
- data: APIGuildChannel<GuildChannelType>
- guild: Guild
Returns GuildChannels

Static toJSON

toJSON(data: any): any

Inherited from Channel.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc