Class GuildTextChannel

Hierarchy

BaseGuildTextChannel
- GuildTextChannel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GuildTextChannel(client: Client): GuildTextChannel

Inherited from BaseGuildTextChannel.constructor
- Defined in src/structures/templates/BaseGuildTextChannel.ts:14
Parameters
- client: Client
Returns GuildTextChannel

Properties

client

client: Client

guildId

guildId: null | string = null

id

id: string

lastMessageId

lastMessageId: null | string = null

lastPinAt

lastPinAt: null | Date = null

messages

messages: ChannelMessageManager = ...

name

name: string = ''

nsfw

nsfw: boolean = false

parentId

parentId: null | string = null

position

position: number = 0

topic

topic: null | string = null

type

type: ChannelType = ChannelType.GuildCategory

Accessors

children

get children(): GuildChannels[]

Inherited from BaseGuildTextChannel.children
- Defined in src/structures/GuildChannel.ts:23
Returns GuildChannels[]

createMessage

get createMessage(): (data: string | MessagePayload | MessagePayloadData, cache?: boolean) => Promise<Message<TextChannel>>

Inherited from BaseGuildTextChannel.createMessage
- Defined in src/structures/templates/BaseTextChannel.ts:56
Returns (data: string | MessagePayload | MessagePayloadData, cache?: boolean) => Promise<Message<TextChannel>>
- - (data: string | MessagePayload | MessagePayloadData, cache?: boolean): Promise<Message<TextChannel>>
  - Parameters
    - data: string | MessagePayload | MessagePayloadData
    - cache: boolean = false
    Returns Promise<Message<TextChannel>>

createdAt

get createdAt(): Date

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

createdTimestamp

get createdTimestamp(): number

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

delete

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

Inherited from BaseGuildTextChannel.delete
- 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 BaseGuildTextChannel.guild
- Defined in src/structures/Channel.ts:23
Returns null | Guild

lastPinTimestamp

get lastPinTimestamp(): null | number

Inherited from BaseGuildTextChannel.lastPinTimestamp
- Defined in src/structures/templates/BaseGuildTextChannel.ts:10
Returns null | number

parent

get parent(): undefined | GuildChannels

Inherited from BaseGuildTextChannel.parent
- Defined in src/structures/GuildChannel.ts:19
Returns undefined | GuildChannels

Methods

_deserialise

_deserialise(data: APIGuildTextChannel<GuildText>): GuildTextChannel

Overrides BaseGuildTextChannel._deserialise
- Defined in src/structures/GuildTextChannel.ts:7
Parameters
- data: APIGuildTextChannel<GuildText>
Returns GuildTextChannel

_set_guild

_set_guild(id: string): GuildTextChannel

Inherited from BaseGuildTextChannel._set_guild
- Defined in src/structures/Channel.ts:35
Parameters
- id: string
Returns GuildTextChannel

fetch

fetch(): Promise<GuildTextChannel>

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

setName

setName(name: string): Promise<GuildTextChannel>

Inherited from BaseGuildTextChannel.setName
- Defined in src/structures/GuildChannel.ts:73
Parameters
- name: string
Returns Promise<GuildTextChannel>

setNsfw

setNsfw(nsfw: boolean): Promise<GuildTextChannel>

Inherited from BaseGuildTextChannel.setNsfw
- Defined in src/structures/GuildChannel.ts:81
Parameters
- nsfw: boolean
Returns Promise<GuildTextChannel>

setParent

setParent(parent: string | GuildChannels): void

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

setPosition

setPosition(position: number): Promise<GuildTextChannel>

Inherited from BaseGuildTextChannel.setPosition
- Defined in src/structures/GuildChannel.ts:77
Parameters
- position: number
Returns Promise<GuildTextChannel>

toJSON

toJSON(): APIGuildTextChannel<GuildText>

Overrides BaseGuildTextChannel.toJSON
- Defined in src/structures/GuildTextChannel.ts:15
Returns APIGuildTextChannel<GuildText>

Static create

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

Inherited from BaseGuildTextChannel.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

Inherited from BaseGuildTextChannel.resolve
- 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 BaseGuildTextChannel.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc