Class ForumChannel

availableTags

Readonlyclient

defaultAutoArchiveDuration

defaultReactionEmoji

defaultSortOrder

defaultThreadRateLimitPerUser

flags

guild

guildId

id

lastMessageId

lastPinTimestamp

name

nsfw

parentId

permissionOverwrites

rateLimitPerUser

rawPosition

threads

topic

createdAt

• get createdAt(): Date

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Returns number

deletable

• get deletable(): boolean

  Returns boolean

manageable

• get manageable(): boolean

  Returns boolean

members

• get members(): Collection<string, GuildMember>

  Returns Collection<string, GuildMember>

parent

• get parent(): null | CategoryChannel

  Returns null | CategoryChannel

partial

• get partial(): false

  Returns false

permissionsLocked

• get permissionsLocked(): null | boolean

  Returns null | boolean

position

• get position(): number

  Returns number

url

• get url(): string

  Returns string

viewable

• get viewable(): boolean

  Returns boolean

clone

• clone(options?: GuildChannelCloneOptions): Promise<ForumChannel>

  Parameters

  • Optionaloptions: GuildChannelCloneOptions

  Returns Promise<ForumChannel>

createInvite

• createInvite(options?: InviteCreateOptions): Promise<Invite>

  Parameters

  • Optionaloptions: InviteCreateOptions

  Returns Promise<Invite>

createWebhook

• createWebhook(options: ChannelWebhookCreateOptions): Promise<Webhook<Incoming>>

  Parameters

  • options: ChannelWebhookCreateOptions

  Returns Promise<Webhook<Incoming>>

delete

• delete(reason?: string): Promise<ForumChannel>

  Parameters

  • Optionalreason: string

  Returns Promise<ForumChannel>

edit

• edit(options: GuildChannelEditOptions): Promise<ForumChannel>

  Parameters

  • options: GuildChannelEditOptions

  Returns Promise<ForumChannel>

equals

• equals(channel: GuildChannel): boolean

  Parameters

  • channel: GuildChannel

  Returns boolean

fetch

• fetch(force?: boolean): Promise<ForumChannel>

  Parameters

  • Optionalforce: boolean

  Returns Promise<ForumChannel>

fetchInvites

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

  Parameters

  • Optionalcache: boolean

  Returns Promise<Collection<string, Invite>>

fetchWebhooks

• fetchWebhooks(): Promise<
      Collection<string, Webhook<Incoming | ChannelFollower>>,
  >

  Returns Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>

isDMBased

• isDMBased(): this is DMChannel | PartialDMChannel | PartialGroupDMChannel

  Returns this is DMChannel | PartialDMChannel | PartialGroupDMChannel

isSendable

• isSendable(): this is SendableChannels

  Returns this is SendableChannels

isTextBased

• isTextBased(): this is GuildBasedChannel & TextBasedChannel

  Returns this is GuildBasedChannel & TextBasedChannel

isThread

• isThread(): this is AnyThreadChannel

  Returns this is AnyThreadChannel

isThreadOnly

• isThreadOnly(): this is ThreadOnlyChannel

  Returns this is ThreadOnlyChannel

isVoiceBased

• isVoiceBased(): this is VoiceBasedChannel

  Returns this is VoiceBasedChannel

lockPermissions

• lockPermissions(): Promise<ForumChannel>

  Returns Promise<ForumChannel>

permissionsFor

• permissionsFor(
      memberOrRole: GuildMember | Role,
      checkAdmin?: boolean,
  ): Readonly<PermissionsBitField>

  Parameters

  • memberOrRole: GuildMember | Role
  • OptionalcheckAdmin: boolean

  Returns Readonly<PermissionsBitField>

• 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>

setAvailableTags

• setAvailableTags(
      tags: readonly GuildForumTagData[],
      reason?: string,
  ): Promise<ForumChannel>

  Parameters

  • tags: readonly GuildForumTagData[]
  • Optionalreason: string

  Returns Promise<ForumChannel>

setDefaultAutoArchiveDuration

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

  Parameters

  • defaultAutoArchiveDuration: ThreadAutoArchiveDuration
  • Optionalreason: string

  Returns Promise<ForumChannel>

setDefaultReactionEmoji

• setDefaultReactionEmoji(
      emojiId: null | DefaultReactionEmoji,
      reason?: string,
  ): Promise<ForumChannel>

  Parameters

  • emojiId: null | DefaultReactionEmoji
  • Optionalreason: string

  Returns Promise<ForumChannel>

setDefaultSortOrder

• setDefaultSortOrder(
      defaultSortOrder: null | SortOrderType,
      reason?: string,
  ): Promise<ForumChannel>

  Parameters

  • defaultSortOrder: null | SortOrderType
  • Optionalreason: string

  Returns Promise<ForumChannel>

setDefaultThreadRateLimitPerUser

• setDefaultThreadRateLimitPerUser(
      rateLimit: number,
      reason?: string,
  ): Promise<ForumChannel>

  Parameters

  • rateLimit: number
  • Optionalreason: string

  Returns Promise<ForumChannel>

setName

• setName(name: string, reason?: string): Promise<ForumChannel>

  Parameters

  • name: string
  • Optionalreason: string

  Returns Promise<ForumChannel>

setNSFW

• setNSFW(
      nsfw?: boolean,
      reason?: string,
  ): Promise<TextBasedChannelFields<boolean, boolean>>

  Parameters

  • Optionalnsfw: boolean
  • Optionalreason: string

  Returns Promise<TextBasedChannelFields<boolean, boolean>>

setParent

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

  Parameters

  • channel: null | CategoryChannelResolvable
  • Optionaloptions: SetParentOptions

  Returns Promise<ForumChannel>

setPosition

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

  Parameters

  • position: number
  • Optionaloptions: SetChannelPositionOptions

  Returns Promise<ForumChannel>

setRateLimitPerUser

• setRateLimitPerUser(
      rateLimitPerUser: number,
      reason?: string,
  ): Promise<TextBasedChannelFields<boolean, boolean>>

  Parameters

  • rateLimitPerUser: number
  • Optionalreason: string

  Returns Promise<TextBasedChannelFields<boolean, boolean>>

setTopic

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

  Parameters

  • topic: null | string
  • Optionalreason: string

  Returns Promise<ForumChannel>

toJSON

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

  Parameters

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

  Returns unknown

toString

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

  Returns a string representation of an object.

  Returns `<#${string}>`

valueOf

• valueOf(): string

  Returns string