Class CategoryChannel

Represents a guild category channel.

Hierarchy

Constructors

Properties

The channels in this category.

guildID: string

The id of the guild this channel is in.

id: string
name: string

The name of this channel.

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.

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

Methods

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

  • 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