Class ForumChannel

Represents a forum channel.

Hierarchy

Constructors

Properties

availableTags: ForumTag[]

The usable tags for threads.

defaultAutoArchiveDuration: 60 | 1440 | 4320 | 10080

The default auto archive duration for threads.

defaultForumLayout: ForumLayoutTypes

The default forum layout used to display threads.

defaultReactionEmoji: null | ForumEmoji

The default reaction emoji for threads.

defaultSortOrder: null | SortOrderTypes

The default sort order mode used to sort threads.

defaultThreadRateLimitPerUser: number

The default amount of seconds between non-moderators sending messages in threads.

flags: number

The flags for this channel, see ChannelFlags.

guildID: string

The id of the guild this channel is in.

id: string
lastThread?: null | PublicThreadChannel

The most recently created thread.

lastThreadID: null | string

The ID of most recently created thread.

name: string

The name of this channel.

nsfw: boolean

If this channel is age gated.

parentID: null | string

The ID of the parent of this channel, if applicable.

permissionOverwrites: TypedCollection<string, RawOverwrite, PermissionOverwrite, []>

The permission overwrites of this channel.

position: number

The position of this channel on the sidebar.

rateLimitPerUser: number

The amount of seconds between non-moderators creating threads.

template: string

Undocumented property.

The threads in this channel.

topic: null | string

The guidelines of this forum channel.

The type of this channel.

Accessors

  • get createdAt(): Date
  • Returns Date

  • get guild(): Guild
  • The guild associated with this channel. This will throw an error if the guild is not cached.

    Returns Guild

  • get mention(): string
  • A string that will mention this channel.

    Returns string

  • get parent(): undefined | null | CategoryChannel
  • The parent of this channel, if applicable. This will be a text/announcement/forum channel if we're in a thread, category otherwise.

    Returns undefined | null | CategoryChannel

Methods

  • Create an invite for this channel. If the guild is not a COMMUNITY server, invites can only be made to last 30 days.

    Parameters

    Returns Promise<Invite<"withMetadata", ForumChannel>>

  • Create a webhook in this channel.

    Parameters

    Returns Promise<Webhook>

  • Close a direct message, leave a group channel, or delete a guild channel.

    Returns Promise<void>

  • Delete a permission overwrite on this channel.

    Parameters

    • overwriteID: string

      The ID of the permission overwrite to delete.

    • Optional reason: string

      The reason for deleting the permission overwrite.

    Returns Promise<void>

  • Edit a permission overwrite on this channel.

    Parameters

    • overwriteID: string

      The ID of the permission overwrite to edit.

    • options: EditPermissionOptions

      The options for editing the permission overwrite.

    Returns Promise<void>

  • Get the invites of this channel.

    Returns Promise<Invite<"withMetadata", ForumChannel>[]>

  • Get the webhooks in this channel.

    Returns Promise<Webhook[]>

  • Get the permissions of a member. If providing an id, the member must be cached.

    Parameters

    • member: string | Member

      The member to get the permissions of.

    Returns Permission

  • Create a thread in a forum channel.

    Parameters

    Returns Promise<PublicThreadChannel>

  • Returns string

  • Parameters

    Returns void

  • Parameters

    • Optional timestamp: number | Date

    Returns string

  • Parameters

    • id: string

    Returns Date

  • Parameters

    • id: string

    Returns number

Generated using TypeDoc