Class BaseGuildTextChannel

Hierarchy (View Summary)

TextBasedChannelFields<true>
GuildChannel
- BaseGuildTextChannel
  - NewsChannel
  - TextChannel

Constructors

`Protected`constructor

new BaseGuildTextChannel(
    guild: Guild,
    data?: RawGuildChannelData,
    client?: Client<true>,
    immediatePatch?: boolean,
): BaseGuildTextChannel
Parameters
- guild: Guild
- Optionaldata: RawGuildChannelData
- Optionalclient: Client<true>
- OptionalimmediatePatch: boolean
Returns BaseGuildTextChannel
Inherited from GuildChannel.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:717

Properties

`Readonly`client

client: Client<true>

`Optional`defaultAutoArchiveDuration

defaultAutoArchiveDuration?: ThreadAutoArchiveDuration

defaultThreadRateLimitPerUser

defaultThreadRateLimitPerUser: null | number

flags

flags: Readonly<ChannelFlagsBitField>

guild

guild: Guild

guildId

guildId: string

id

id: string

lastMessageId

lastMessageId: null | string

lastPinTimestamp

lastPinTimestamp: null | number

messages

messages: GuildMessageManager

name

name: string

nsfw

nsfw: boolean

parentId

parentId: null | string

permissionOverwrites

permissionOverwrites: PermissionOverwriteManager

rateLimitPerUser

rateLimitPerUser: null | number

rawPosition

rawPosition: number

threads

threads: GuildTextThreadManager<
AnnouncementThread
| AllowedThreadTypeForTextChannel,
>

topic

topic: null | string

type

type: GuildChannelTypes

Accessors

createdAt

get createdAt(): Date
Returns Date
- Defined in node_modules/discord.js/typings/index.d.ts:1754

createdTimestamp

get createdTimestamp(): number
Returns number
- Defined in node_modules/discord.js/typings/index.d.ts:1755

deletable

get deletable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:1756

lastMessage

get lastMessage(): null | Message<boolean>
Returns null | Message<boolean>
Inherited from TextBasedChannelFields.lastMessage
- Defined in node_modules/discord.js/typings/index.d.ts:5230

lastPinAt

get lastPinAt(): null | Date
Returns null | Date
Inherited from TextBasedChannelFields.lastPinAt
- Defined in node_modules/discord.js/typings/index.d.ts:5232

manageable

get manageable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:1760

members

get members(): Collection<string, GuildMember>
Returns Collection<string, GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:1761

parent

get parent(): null | CategoryChannel
Returns null | CategoryChannel
- Defined in node_modules/discord.js/typings/index.d.ts:1763

partial

get partial(): false
Returns false
- Defined in node_modules/discord.js/typings/index.d.ts:1043

permissionsLocked

get permissionsLocked(): null | boolean
Returns null | boolean
- Defined in node_modules/discord.js/typings/index.d.ts:1766

position

get position(): number
Returns number
- Defined in node_modules/discord.js/typings/index.d.ts:1767

url

get url(): string
Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:1045

viewable

get viewable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:1770

Methods

awaitMessageComponent

awaitMessageComponent<ComponentType extends MessageComponentType>(
options?: AwaitMessageCollectorOptionsParams<ComponentType, true>,
): Promise<MappedInteractionTypes<boolean>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: AwaitMessageCollectorOptionsParams<ComponentType, true>
Returns Promise<MappedInteractionTypes<boolean>[ComponentType]>
Inherited from TextBasedChannelFields.awaitMessageComponent
- Defined in node_modules/discord.js/typings/index.d.ts:5234

awaitMessages

awaitMessages(
options?: AwaitMessagesOptions,
): Promise<Collection<string, Message<boolean>>>
Parameters
- Optionaloptions: AwaitMessagesOptions
Returns Promise<Collection<string, Message<boolean>>>
Inherited from TextBasedChannelFields.awaitMessages
- Defined in node_modules/discord.js/typings/index.d.ts:5237

bulkDelete

bulkDelete(
    messages:
        | number
        | Collection<string, Message<boolean>>
        | readonly MessageResolvable[],
    filterOld?: boolean,
): Promise<
    Collection<string, undefined | Message<boolean> | PartialMessage>,
>
Parameters
- messages: number | Collection<string, Message<boolean>> | readonly MessageResolvable[]
- OptionalfilterOld: boolean
Returns Promise<Collection<string, undefined | Message<boolean> | PartialMessage>>
Inherited from TextBasedChannelFields.bulkDelete
- Defined in node_modules/discord.js/typings/index.d.ts:5238

clone

clone(options?: GuildChannelCloneOptions): Promise<BaseGuildTextChannel>
Parameters
- Optionaloptions: GuildChannelCloneOptions
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.clone
- Defined in node_modules/discord.js/typings/index.d.ts:1771

createInvite

createInvite(options?: InviteCreateOptions): Promise<Invite>
Parameters
- Optionaloptions: InviteCreateOptions
Returns Promise<Invite>
- Defined in node_modules/discord.js/typings/index.d.ts:724

createMessageCollector

createMessageCollector(options?: MessageCollectorOptions): MessageCollector
Parameters
- Optionaloptions: MessageCollectorOptions
Returns MessageCollector
Inherited from TextBasedChannelFields.createMessageCollector
- Defined in node_modules/discord.js/typings/index.d.ts:5245

createMessageComponentCollector

createMessageComponentCollector<ComponentType extends MessageComponentType>(
options?: MessageChannelCollectorOptionsParams<ComponentType, true>,
): InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: MessageChannelCollectorOptionsParams<ComponentType, true>
Returns InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>
Inherited from TextBasedChannelFields.createMessageComponentCollector
- Defined in node_modules/discord.js/typings/index.d.ts:5242

createWebhook

createWebhook(options: ChannelWebhookCreateOptions): Promise<Webhook<Incoming>>
Parameters
- options: ChannelWebhookCreateOptions
Returns Promise<Webhook<Incoming>>
Inherited from TextBasedChannelFields.createWebhook
- Defined in node_modules/discord.js/typings/index.d.ts:5246

delete

delete(reason?: string): Promise<BaseGuildTextChannel>
Parameters
- Optionalreason: string
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.delete
- Defined in node_modules/discord.js/typings/index.d.ts:1772

edit

edit(options: GuildChannelEditOptions): Promise<BaseGuildTextChannel>
Parameters
- options: GuildChannelEditOptions
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.edit
- Defined in node_modules/discord.js/typings/index.d.ts:1773

equals

equals(channel: GuildChannel): boolean
Parameters
- channel: GuildChannel
Returns boolean
Inherited from GuildChannel.equals
- Defined in node_modules/discord.js/typings/index.d.ts:1774

fetch

fetch(force?: boolean): Promise<BaseGuildTextChannel>
Parameters
- Optionalforce: boolean
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.fetch
- Defined in node_modules/discord.js/typings/index.d.ts:1047

fetchInvites

fetchInvites(cache?: boolean): Promise<Collection<string, Invite>>
Parameters
- Optionalcache: boolean
Returns Promise<Collection<string, Invite>>
- Defined in node_modules/discord.js/typings/index.d.ts:725

fetchWebhooks

fetchWebhooks(): Promise<
Collection<string, Webhook<Incoming | ChannelFollower>>,
>
Returns Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>
Inherited from TextBasedChannelFields.fetchWebhooks
- Defined in node_modules/discord.js/typings/index.d.ts:5247

isDMBased

isDMBased(): this is DMChannel | PartialDMChannel | PartialGroupDMChannel
Returns this is DMChannel | PartialDMChannel | PartialGroupDMChannel
Inherited from GuildChannel.isDMBased
- Defined in node_modules/discord.js/typings/index.d.ts:1050

isSendable

isSendable(): this is SendableChannels
Returns this is SendableChannels
Inherited from GuildChannel.isSendable
- Defined in node_modules/discord.js/typings/index.d.ts:1053

isTextBased

isTextBased(): this is GuildBasedChannel & TextBasedChannel
Returns this is GuildBasedChannel & TextBasedChannel
Inherited from GuildChannel.isTextBased
- Defined in node_modules/discord.js/typings/index.d.ts:1784

isThread

isThread(): this is AnyThreadChannel
Returns this is AnyThreadChannel
Inherited from GuildChannel.isThread
- Defined in node_modules/discord.js/typings/index.d.ts:1048

isThreadOnly

isThreadOnly(): this is ThreadOnlyChannel
Returns this is ThreadOnlyChannel
Inherited from GuildChannel.isThreadOnly
- Defined in node_modules/discord.js/typings/index.d.ts:1052

isVoiceBased

isVoiceBased(): this is VoiceBasedChannel
Returns this is VoiceBasedChannel
Inherited from GuildChannel.isVoiceBased
- Defined in node_modules/discord.js/typings/index.d.ts:1051

lockPermissions

lockPermissions(): Promise<BaseGuildTextChannel>
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.lockPermissions
- Defined in node_modules/discord.js/typings/index.d.ts:1775

permissionsFor

permissionsFor(
memberOrRole: GuildMember | Role,
checkAdmin?: boolean,
): Readonly<PermissionsBitField>
Parameters
- memberOrRole: GuildMember | Role
- OptionalcheckAdmin: boolean
Returns Readonly<PermissionsBitField>
Inherited from GuildChannel.permissionsFor
- Defined in node_modules/discord.js/typings/index.d.ts:1776
permissionsFor(
    memberOrRole:
        | string
        | User
        | GuildMember
        | Role
        | Message<boolean>
        | ThreadMember<boolean>,
    checkAdmin?: boolean,
): null | Readonly<PermissionsBitField>
Parameters
- memberOrRole: string | User | GuildMember | Role | Message<boolean> | ThreadMember<boolean>
- OptionalcheckAdmin: boolean
Returns null | Readonly<PermissionsBitField>
Inherited from GuildChannel.permissionsFor
- Defined in node_modules/discord.js/typings/index.d.ts:1777

send

send(
options: string | MessagePayload | MessageCreateOptions,
): Promise<Message<true>>
Parameters
- options: string | MessagePayload | MessageCreateOptions
Returns Promise<Message<true>>
Inherited from TextBasedChannelFields.send
- Defined in node_modules/discord.js/typings/index.d.ts:5224

sendTyping

sendTyping(): Promise<void>
Returns Promise<void>
Inherited from TextBasedChannelFields.sendTyping
- Defined in node_modules/discord.js/typings/index.d.ts:5248

setDefaultAutoArchiveDuration

setDefaultAutoArchiveDuration(
defaultAutoArchiveDuration: ThreadAutoArchiveDuration,
reason?: string,
): Promise<BaseGuildTextChannel>
Parameters
- defaultAutoArchiveDuration: ThreadAutoArchiveDuration
- Optionalreason: string
Returns Promise<BaseGuildTextChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:726

setName

setName(name: string, reason?: string): Promise<BaseGuildTextChannel>
Parameters
- name: string
- Optionalreason: string
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.setName
- Defined in node_modules/discord.js/typings/index.d.ts:1781

setNSFW

setNSFW(nsfw?: boolean, reason?: string): Promise<BaseGuildTextChannel>
Parameters
- Optionalnsfw: boolean
- Optionalreason: string
Returns Promise<BaseGuildTextChannel>
Inherited from TextBasedChannelFields.setNSFW
- Defined in node_modules/discord.js/typings/index.d.ts:5250

setParent

setParent(
channel: null | CategoryChannelResolvable,
options?: SetParentOptions,
): Promise<BaseGuildTextChannel>
Parameters
- channel: null | CategoryChannelResolvable
- Optionaloptions: SetParentOptions
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.setParent
- Defined in node_modules/discord.js/typings/index.d.ts:1782

setPosition

setPosition(
position: number,
options?: SetChannelPositionOptions,
): Promise<BaseGuildTextChannel>
Parameters
- position: number
- Optionaloptions: SetChannelPositionOptions
Returns Promise<BaseGuildTextChannel>
Inherited from GuildChannel.setPosition
- Defined in node_modules/discord.js/typings/index.d.ts:1783

setRateLimitPerUser

setRateLimitPerUser(
rateLimitPerUser: number,
reason?: string,
): Promise<BaseGuildTextChannel>
Parameters
- rateLimitPerUser: number
- Optionalreason: string
Returns Promise<BaseGuildTextChannel>
Inherited from TextBasedChannelFields.setRateLimitPerUser
- Defined in node_modules/discord.js/typings/index.d.ts:5249

setTopic

setTopic(topic: null | string, reason?: string): Promise<BaseGuildTextChannel>
Parameters
- topic: null | string
- Optionalreason: string
Returns Promise<BaseGuildTextChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:730

setType

setType(type: GuildText, reason?: string): Promise<TextChannel>
Parameters
- type: GuildText
- Optionalreason: string
Returns Promise<TextChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:731
setType(type: GuildAnnouncement, reason?: string): Promise<NewsChannel>
Parameters
- type: GuildAnnouncement
- Optionalreason: string
Returns Promise<NewsChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:732

toJSON

toJSON(...props: Record<string, string | boolean>[]): unknown
Parameters
- ...props: Record<string, string | boolean>[]
Returns unknown
Inherited from GuildChannel.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:560

toString

toString(): `<#${string}>`
Returns a string representation of an object.

Returns `<#${string}>`
Inherited from GuildChannel.toString
- Defined in node_modules/discord.js/typings/index.d.ts:1785

valueOf

valueOf(): string
Returns string
Inherited from GuildChannel.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:561

Class BaseGuildTextChannel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns BaseGuildTextChannel

Properties

Readonlyclient

OptionaldefaultAutoArchiveDuration

defaultThreadRateLimitPerUser

flags

guild

guildId

id

lastMessageId

lastPinTimestamp

messages

name

nsfw

parentId

permissionOverwrites

rateLimitPerUser

rawPosition

threads

topic

type

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

deletable

Returns boolean

lastMessage

Returns null | Message<boolean>

lastPinAt

Returns null | Date

manageable

Returns boolean

members

Returns Collection<string, GuildMember>

parent

Returns null | CategoryChannel

partial

Returns false

permissionsLocked

Returns null | boolean

position

Returns number

url

Returns string

viewable

Returns boolean

Methods

awaitMessageComponent

Type Parameters

Parameters

Returns Promise<MappedInteractionTypes<boolean>[ComponentType]>

awaitMessages

Parameters

Returns Promise<Collection<string, Message<boolean>>>

bulkDelete

Parameters

Returns Promise<Collection<string, undefined | Message<boolean> | PartialMessage>>

clone

Parameters

Returns Promise<BaseGuildTextChannel>

createInvite

Parameters

Returns Promise<Invite>

createMessageCollector

Parameters

Returns MessageCollector

createMessageComponentCollector

Type Parameters

`Protected`constructor

`Readonly`client

`Optional`defaultAutoArchiveDuration