Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TextChannel
    • TicketChannel

Index

Constructors

constructor

Properties

Readonly calculatedPosition

calculatedPosition: number

Readonly client

client: Client<boolean>

Readonly createdAt

createdAt: Date

Readonly createdTimestamp

createdTimestamp: number

Optional defaultAutoArchiveDuration

defaultAutoArchiveDuration?: ThreadAutoArchiveDuration

Readonly deletable

deletable: boolean

deleted

deleted: boolean

guild

guild: Guild

guildId

guildId: string

id

id: string

Readonly lastMessage

lastMessage: null | Message

lastMessageId

lastMessageId: null | string

Readonly lastPinAt

lastPinAt: null | Date

lastPinTimestamp

lastPinTimestamp: null | number

Readonly manageable

manageable: boolean

Readonly members

members: Collection<string, GuildMember>

messages

messages: MessageManager

name

name: string

nsfw

nsfw: boolean

Readonly owner

owner: GuildMember

Readonly parent

parent: null | CategoryChannel

parentId

parentId: null | string

Readonly partial

partial: false

permissionOverwrites

permissionOverwrites: PermissionOverwriteManager

Readonly permissionsLocked

permissionsLocked: null | boolean

Readonly position

position: number

rateLimitPerUser

rateLimitPerUser: number

rawPosition

rawPosition: number

threads

threads: ThreadManager<AllowedThreadTypeForTextChannel>

topic

topic: null | string

type

type: "GUILD_TEXT"

Readonly viewable

viewable: boolean

Methods

awaitMessageComponent

  • awaitMessageComponent<T>(options?: AwaitMessageComponentOptions<T>): Promise<T>
  • Type parameters

    • T: MessageComponentInteraction<T> = MessageComponentInteraction

    Parameters

    • Optional options: AwaitMessageComponentOptions<T>

    Returns Promise<T>

awaitMessages

  • awaitMessages(options?: AwaitMessagesOptions): Promise<Collection<string, Message>>
  • Parameters

    • Optional options: AwaitMessagesOptions

    Returns Promise<Collection<string, Message>>

bulkDelete

  • bulkDelete(messages: number | Collection<string, Message> | readonly MessageResolvable[], filterOld?: boolean): Promise<Collection<string, Message>>
  • Parameters

    • messages: number | Collection<string, Message> | readonly MessageResolvable[]
    • Optional filterOld: boolean

    Returns Promise<Collection<string, Message>>

clone

  • clone(options?: GuildChannelCloneOptions): Promise<TicketChannel>
  • Parameters

    • Optional options: GuildChannelCloneOptions

    Returns Promise<TicketChannel>

createInvite

  • createInvite(options?: CreateInviteOptions): Promise<Invite>
  • Parameters

    • Optional options: CreateInviteOptions

    Returns Promise<Invite>

createMessageCollector

  • createMessageCollector(options?: MessageCollectorOptions): MessageCollector
  • Parameters

    • Optional options: MessageCollectorOptions

    Returns MessageCollector

createMessageComponentCollector

  • createMessageComponentCollector<T>(options?: InteractionCollectorOptions<T>): InteractionCollector<T>
  • Type parameters

    • T: MessageComponentInteraction<T> = MessageComponentInteraction

    Parameters

    • Optional options: InteractionCollectorOptions<T>

    Returns InteractionCollector<T>

createWebhook

  • createWebhook(name: string, options?: ChannelWebhookCreateOptions): Promise<Webhook>
  • Parameters

    • name: string
    • Optional options: ChannelWebhookCreateOptions

    Returns Promise<Webhook>

delete

  • delete(): Promise<Channel>
  • Returns Promise<Channel>

edit

  • Parameters

    • data: ChannelData
    • Optional reason: string

    Returns Promise<TicketChannel>

equals

  • equals(channel: GuildChannel): boolean
  • Parameters

    • channel: GuildChannel

    Returns boolean

fetch

  • fetch(force?: boolean): Promise<Channel>
  • Parameters

    • Optional force: boolean

    Returns Promise<Channel>

fetchInvites

  • fetchInvites(cache?: boolean): Promise<Collection<string, Invite>>
  • Parameters

    • Optional cache: boolean

    Returns Promise<Collection<string, Invite>>

fetchWebhooks

  • fetchWebhooks(): Promise<Collection<string, Webhook>>
  • Returns Promise<Collection<string, Webhook>>

isText

  • isText(): this is TextChannel | NewsChannel
  • Returns this is TextChannel | NewsChannel

isThread

  • isThread(): this is ThreadChannel
  • Returns this is ThreadChannel

isVoice

  • isVoice(): this is VoiceChannel | StageChannel
  • Returns this is VoiceChannel | StageChannel

lockPermissions

  • Returns Promise<TicketChannel>

permissionsFor

  • permissionsFor(memberOrRole: GuildMember | Role): Readonly<Permissions>
  • permissionsFor(memberOrRole: string | GuildMember | Role | User | Message | ThreadMember): null | Readonly<Permissions>
  • Parameters

    • memberOrRole: GuildMember | Role

    Returns Readonly<Permissions>

  • Parameters

    • memberOrRole: string | GuildMember | Role | User | Message | ThreadMember

    Returns null | Readonly<Permissions>

send

  • send(options: string | MessagePayload | MessageOptions): Promise<Message>
  • Parameters

    • options: string | MessagePayload | MessageOptions

    Returns Promise<Message>

sendTyping

  • sendTyping(): Promise<void>
  • Returns Promise<void>

setDefaultAutoArchiveDuration

  • setDefaultAutoArchiveDuration(defaultAutoArchiveDuration: ThreadAutoArchiveDuration, reason?: string): Promise<TicketChannel>
  • Parameters

    • defaultAutoArchiveDuration: ThreadAutoArchiveDuration
    • Optional reason: string

    Returns Promise<TicketChannel>

setNSFW

  • Parameters

    • nsfw: boolean
    • Optional reason: string

    Returns Promise<TicketChannel>

setName

  • Parameters

    • name: string
    • Optional reason: string

    Returns Promise<TicketChannel>

setParent

  • setParent(channel: null | CategoryChannelResolvable, options?: SetParentOptions): Promise<TicketChannel>
  • Parameters

    • channel: null | CategoryChannelResolvable
    • Optional options: SetParentOptions

    Returns Promise<TicketChannel>

setPosition

  • setPosition(position: number, options?: SetChannelPositionOptions): Promise<TicketChannel>
  • Parameters

    • position: number
    • Optional options: SetChannelPositionOptions

    Returns Promise<TicketChannel>

setRateLimitPerUser

  • setRateLimitPerUser(rateLimitPerUser: number, reason?: string): Promise<TextChannel>
  • Parameters

    • rateLimitPerUser: number
    • Optional reason: string

    Returns Promise<TextChannel>

setTopic

  • setTopic(topic: null | string, reason?: string): Promise<TicketChannel>
  • Parameters

    • topic: null | string
    • Optional reason: string

    Returns Promise<TicketChannel>

setType

  • setType(type: Pick<typeof ChannelTypes, "GUILD_TEXT">, reason?: string): Promise<TextChannel>
  • setType(type: Pick<typeof ChannelTypes, "GUILD_NEWS">, reason?: string): Promise<NewsChannel>
  • Parameters

    • type: Pick<typeof ChannelTypes, "GUILD_TEXT">
    • Optional reason: string

    Returns Promise<TextChannel>

  • Parameters

    • type: Pick<typeof ChannelTypes, "GUILD_NEWS">
    • Optional reason: string

    Returns Promise<NewsChannel>

toJSON

  • toJSON(...props: Record<string, string | boolean>[]): unknown
  • Parameters

    • Rest ...props: Record<string, string | boolean>[]

    Returns unknown

toString

  • toString(): `<#${string}>`
  • toString(): string
  • Returns `<#${string}>`

  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): string
  • valueOf(): Object
  • Returns string

  • Returns the primitive value of the specified object.

    Returns Object

Static from

Generated using TypeDoc