Class CategoryChannel

client

flags

guildID

id

name

parentID

createdAt

• get createdAt(): Date

• Returns Date

guild

• get guild(): Guild

• The guild associated with this channel. This will throw an error if the guild is not cached.

  Returns Guild

isObfuscated

• get isObfuscated(): boolean

• If this channel's metadata has been obfuscated because the client can't view it. Requires the CHANNEL_OBFUSCATION capability.

  Returns boolean

mention

• get mention(): string

• A string that will mention this channel.

  Returns string

parent

• get parent(): undefined | null | ParentChannelType<this>

• The parent of this channel, if applicable.

  If the channel is an AnnouncementThread, PublicThread, or PrivateThread, this will be a TextChannel, AnnouncementChannel, ForumChannel, or MediaChannel.

  If the channel is a TextChannel, VoiceChannel, AnnouncementChannel, ForumChannel, or MediaChannel, this will be a CategoryChannel.

  Returns undefined | null | ParentChannelType<this>

  If undefined, no attempt was made to resolve the parent channel. If null, the parent channel was attempted to be resolved but was not found in the client's cache.

delete

• delete(): Promise<void>

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

  Returns Promise<void>

edit

• edit(options): Promise<CategoryChannel>

• Edit this channel.

  Parameters

  • options: EditAnyGuildChannelOptions

    The options for editing the channel.

  Returns Promise<CategoryChannel>

getMemberPermissions

• getMemberPermissions(userID, options?): Promise<Permission>

• Get the computed permissions of a member in this channel, including their roles and member-specific overwrites. Requires the VIEW_CHANNEL permission, and CONNECT for voice and stage channels.

  Parameters

  • userID: string

    The ID of the member.
  • Optional options: GetChannelPermissionsOptions

    The options for getting the permissions.

  Returns Promise<Permission>

getRolePermissions

• getRolePermissions(roleID, options?): Promise<Permission>

• Get the permissions granted by a role together with @everyone in this channel, applying their overwrites. Requires the VIEW_CHANNEL permission, and CONNECT for voice and stage channels.

  Parameters

  • roleID: string

    The ID of the role.
  • Optional options: GetChannelPermissionsOptions

    The options for getting the permissions.

  Returns Promise<Permission>

toString

• toString(): string

• Returns string

Static from

• from<T>(data, client): T

• Type Parameters

  • T extends AnyChannel = AnyChannel

  Parameters

  • data: RawChannel
  • client: Client<ClientEvents>

  Returns T

Static generateID

• generateID(timestamp?): string

• Parameters

  • timestamp: number | Date = ...

  Returns string

Static getCreatedAt

• getCreatedAt(id): Date

• Parameters

  • id: string

  Returns Date

Static getDiscordEpoch

• getDiscordEpoch(id): number

• Parameters

  • id: string

  Returns number