Class ThreadChannel<ThreadOnly>

Type Parameters

ThreadOnly extends boolean = boolean

Hierarchy

Omit<TextBasedChannelFields<true>, "fetchWebhooks" | "createWebhook" | "setNSFW">
BaseChannel
- ThreadChannel
  - PublicThreadChannel
  - PrivateThreadChannel

Index

Constructors

Accessors

archivedAt createdAt createdTimestamp editable guildMembers joinable joined manageable parent partial sendable unarchivable url viewable

Constructors

`Private` constructor

new ThreadChannel<ThreadOnly>(guild, data?, client?): ThreadChannel<ThreadOnly>
Type Parameters
- ThreadOnly extends boolean = boolean
Parameters
- guild: Guild
- Optional data: RawThreadChannelData
- Optional client: Client<true>
Returns ThreadChannel<ThreadOnly>
Inherited from BaseChannel.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:3300

Properties

`Private` _createdTimestamp

_createdTimestamp: null | number

appliedTags

appliedTags: string[]

archiveTimestamp

archiveTimestamp: null | number

archived

archived: null | boolean

autoArchiveDuration

autoArchiveDuration: null | ThreadAutoArchiveDuration

`Readonly` client

client: Client<true>

flags

flags: Readonly<ChannelFlagsBitField>

guild

guild: Guild

guildId

guildId: string

id

id: string

invitable

invitable: null | boolean

lastMessage

lastMessage: null | Message<boolean>

lastMessageId

lastMessageId: null | string

lastPinAt

lastPinAt: null | Date

lastPinTimestamp

lastPinTimestamp: null | number

locked

locked: null | boolean

memberCount

memberCount: null | number

members

members: ThreadMemberManager

messageCount

messageCount: null | number

messages

messages: GuildMessageManager

name

name: string

ownerId

ownerId: null | string

parentId

parentId: null | string

rateLimitPerUser

rateLimitPerUser: null | number

totalMessageSent

totalMessageSent: null | number

type

type: ThreadChannelType

Accessors

archivedAt

get archivedAt(): null | Date
Returns null | Date
- Defined in node_modules/discord.js/typings/index.d.ts:3302

createdAt

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

createdTimestamp

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

editable

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

guildMembers

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

joinable

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

joined

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

manageable

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

parent

get parent(): null | If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>
Returns null | If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:3327

partial

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

sendable

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

unarchivable

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

url

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

viewable

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

Methods

awaitMessageComponent

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

awaitMessages

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

bulkDelete

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

createMessageCollector

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

createMessageComponentCollector

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

delete

delete(reason?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optional reason: string
Returns Promise<ThreadChannel<ThreadOnly>>
Inherited from BaseChannel.delete
- Defined in node_modules/discord.js/typings/index.d.ts:3332

edit

edit(options): Promise<ThreadChannel<ThreadOnly>>
Parameters
- options: ThreadEditOptions
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3333

fetch

fetch(force?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optional force: boolean
Returns Promise<ThreadChannel<ThreadOnly>>
Inherited from BaseChannel.fetch
- Defined in node_modules/discord.js/typings/index.d.ts:972

fetchOwner

fetchOwner(options?): Promise<null | ThreadMember<boolean>>
Parameters
- Optional options: BaseFetchOptions
Returns Promise<null | ThreadMember<boolean>>
- Defined in node_modules/discord.js/typings/index.d.ts:3341

fetchStarterMessage

fetchStarterMessage(options?): Promise<null | Message<true>>
Parameters
- Optional options: BaseFetchOptions
Returns Promise<null | Message<true>>
- Defined in node_modules/discord.js/typings/index.d.ts:3342

isDMBased

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

isTextBased

isTextBased(): this is TextBasedChannel
Returns this is TextBasedChannel
Inherited from BaseChannel.isTextBased
- Defined in node_modules/discord.js/typings/index.d.ts:974

isThread

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

isThreadOnly

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

isVoiceBased

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

join

join(): Promise<ThreadChannel<ThreadOnly>>
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3334

leave

leave(): Promise<ThreadChannel<ThreadOnly>>
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3335

permissionsFor

permissionsFor(memberOrRole, checkAdmin?): Readonly<PermissionsBitField>
Parameters
- memberOrRole: GuildMember | Role
- Optional checkAdmin: boolean
Returns Readonly<PermissionsBitField>
- Defined in node_modules/discord.js/typings/index.d.ts:3336
permissionsFor(memberOrRole, checkAdmin?): null | Readonly<PermissionsBitField>
Parameters
- memberOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>
- Optional checkAdmin: boolean
Returns null | Readonly<PermissionsBitField>
- Defined in node_modules/discord.js/typings/index.d.ts:3337

pin(reason?): Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
Parameters
- Optional reason: string
Returns Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
- Defined in node_modules/discord.js/typings/index.d.ts:3350

send

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

sendTyping

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

setAppliedTags

setAppliedTags(appliedTags, reason?): Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
Parameters
- appliedTags: readonly string[]
- Optional reason: string
Returns Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
- Defined in node_modules/discord.js/typings/index.d.ts:3349

setArchived

setArchived(archived?, reason?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optional archived: boolean
- Optional reason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3343

setAutoArchiveDuration

setAutoArchiveDuration(autoArchiveDuration, reason?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- autoArchiveDuration: ThreadAutoArchiveDuration
- Optional reason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3344

setInvitable

setInvitable(invitable?, reason?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optional invitable: boolean
- Optional reason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3345

setLocked

setLocked(locked?, reason?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optional locked: boolean
- Optional reason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3346

setName

setName(name, reason?): Promise<ThreadChannel<ThreadOnly>>
Parameters
- name: string
- Optional reason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3347

setRateLimitPerUser

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

toJSON

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

toString

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

unpin

unpin(reason?): Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
Parameters
- Optional reason: string
Returns Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
- Defined in node_modules/discord.js/typings/index.d.ts:3351

valueOf

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

Class ThreadChannel<ThreadOnly>

Type Parameters

ThreadOnly extends boolean = boolean

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Type Parameters

ThreadOnly extends boolean = boolean

Parameters

guild: Guild

Optional data: RawThreadChannelData

Optional client: Client<true>

Returns ThreadChannel<ThreadOnly>

Properties

Private _createdTimestamp

appliedTags

archiveTimestamp

archived

autoArchiveDuration

Readonly client

flags

guild

guildId

id

invitable

lastMessage

lastMessageId

lastPinAt

lastPinTimestamp

locked

memberCount

members

messageCount

messages

name

ownerId

parentId

rateLimitPerUser

totalMessageSent

type

Accessors

archivedAt

Returns null | Date

createdAt

Returns null | Date

createdTimestamp

Returns null | number

editable

Returns boolean

guildMembers

Returns Collection<string, GuildMember>

joinable

Returns boolean

joined

Returns boolean

manageable

Returns boolean

parent

Returns null | If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>

partial

Returns false

sendable

Returns boolean

unarchivable

Returns boolean

url

Returns string

viewable

Returns boolean

Methods

awaitMessageComponent

Type Parameters

ComponentType extends MessageComponentType

Parameters

Optional options: AwaitMessageCollectorOptionsParams<ComponentType, true>

`Private` constructor

`Optional` data: RawThreadChannelData

`Optional` client: Client<true>

`Private` _createdTimestamp

`Readonly` client

`Optional` options: AwaitMessageCollectorOptionsParams<ComponentType, true>

`Optional` options: AwaitMessagesOptions

`Optional` filterOld: boolean

`Optional` options: MessageCollectorOptions

`Optional` options: MessageChannelCollectorOptionsParams<ComponentType, true>

`Optional` reason: string

`Optional` force: boolean

`Optional` options: BaseFetchOptions

`Optional` options: BaseFetchOptions

`Optional` checkAdmin: boolean

`Optional` checkAdmin: boolean

`Optional` reason: string