Class CategoryChannel

Implements

CategoryChannel

Index

Constructors

constructor

new CategoryChannel(
    client: Client,
    data:
        | CategoryChannelCacheJSON
        | CategoryChannelDiscordJSON
        | CategoryChannelStorageJSON
        | APIGuildCategoryChannel,
    options: { guildId: string; nocache?: boolean },
): CategoryChannel
Creates the structure for a category channel.
Parameters
- client: Client
  The client instance.
- data:
      | CategoryChannelCacheJSON
      | CategoryChannelDiscordJSON
      | CategoryChannelStorageJSON
      | APIGuildCategoryChannel
  The raw channel data.
- options: { guildId: string; nocache?: boolean }
  The additional options for this structure.
  - guildId: string
    The ID of the guild that this channel belongs to.
  - Optionalnocache?: boolean
    Whether this channel should be cached or not.
Returns CategoryChannel
- Defined in src/structures/CategoryChannel.ts:35

Accessors

guild

get guild(): null | Guild
The guild that this channel belongs to.

Returns null | Guild
- Defined in src/structures/CategoryChannel.ts:182

guildId

get guildId(): string
The ID of the guild that this channel belongs to.

Returns string
Implementation of CategoryChannelType.guildId
- Defined in src/structures/CategoryChannel.ts:172

id

get id(): string
The ID of the channel.

Returns string
Implementation of CategoryChannelType.id
- Defined in src/structures/CategoryChannel.ts:162

mention

get mention(): string
The mention string of the channel.

Returns string
Implementation of CategoryChannelType.mention
- Defined in src/structures/CategoryChannel.ts:236

name

get name(): undefined | string
The name of the channel.

Returns undefined | string
Implementation of CategoryChannelType.name
- Defined in src/structures/CategoryChannel.ts:192

nsfw

get nsfw(): boolean
Whether the channel is nsfw.

Returns boolean
Implementation of CategoryChannelType.nsfw
- Defined in src/structures/CategoryChannel.ts:226

permissionOverwrites

get permissionOverwrites(): PermissionOverwrite[]
The permission overwrites for the channel.

Returns PermissionOverwrite[]
Implementation of CategoryChannelType.permissionOverwrites
- Defined in src/structures/CategoryChannel.ts:216

position

get position(): undefined | number
Returns undefined | number
Implementation of CategoryChannelType.position
- Defined in src/structures/CategoryChannel.ts:206

type

get type(): GuildCategory
The type of channel.

Returns GuildCategory
Implementation of CategoryChannelType.type
- Defined in src/structures/CategoryChannel.ts:202

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/CategoryChannel.ts:252

toJSON

toJSON(
    format?: JsonTypes,
):
    | CategoryChannelCacheJSON
    | CategoryChannelDiscordJSON
    | CategoryChannelStorageJSON
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns
    | CategoryChannelCacheJSON
    | CategoryChannelDiscordJSON
    | CategoryChannelStorageJSON
Method
Implementation of CategoryChannelType.toJSON
- Defined in src/structures/CategoryChannel.ts:263

toString

toString(): string
Returns string
Method
Implementation of CategoryChannelType.toString
- Defined in src/structures/CategoryChannel.ts:244

Class CategoryChannel

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

guildId: string

Optionalnocache?: boolean

Returns CategoryChannel

Accessors

guild

Returns null | Guild

guildId

Returns string

id

Returns string

mention

Returns string

name

Returns undefined | string

nsfw

Returns boolean

permissionOverwrites

Returns PermissionOverwrite[]

position

Returns undefined | number

type

Returns GuildCategory

Methods

[custom]

Returns string

Method

toJSON

Parameters

Returns | CategoryChannelCacheJSON | CategoryChannelDiscordJSON | CategoryChannelStorageJSON

Method

toString

Returns string

Method

Settings

On This Page

`Optional`nocache?: boolean

Returns
| CategoryChannelCacheJSON
| CategoryChannelDiscordJSON
| CategoryChannelStorageJSON