CategoryChannel

CategoryChannel

new CategoryChannel(client, data, options)

Description:

  • Creates the structure for a category channel.

Source:
Parameters:
Name Type Description
client Client

The client instance.
data Object

The raw channel data.
options Object

The additional options for this structure.

Properties
Name Type Description
guildId String

The ID of the guild that this channel belongs to.
nocache Boolean

Whether this channel should be cached or not.

Members

(readonly) _cacheOptions :ChannelCacheOptions

Description:

  • The cache options for this channel.

Source:

The cache options for this channel.

Type:

(readonly, nullable) guild :Guild

Description:

  • The guild that this channel belongs to.

Source:

The guild that this channel belongs to.

Type:

(readonly) guildId :String

Description:

  • The ID of the guild that this channel belongs to.

Source:

The ID of the guild that this channel belongs to.

Type:
  • String

(readonly) id :String

Description:

  • The ID of the channel.

Source:

The ID of the channel.

Type:
  • String

(readonly) mention :String

Description:

  • The mention string of the channel.

Source:

The mention string of the channel.

Type:
  • String

(readonly) name :String

Description:

  • The name of the channel.

Source:

The name of the channel.

Type:
  • String

(readonly) nsfw :Boolean

Description:

  • Whether the channel is nsfw.

Source:

Whether the channel is nsfw.

Type:
  • Boolean

(readonly, nullable) parent :Channel

Description:

  • The parent channel.

Source:

The parent channel.

Type:

(readonly, nullable) parentId :String

Description:

  • The ID of the parent channel.

Source:

The ID of the parent channel.

Type:
  • String

(readonly) permissionOverwrites :Array.<PermissionOverwrite>

Description:

  • The permission overwrites for the channel.

Source:

The permission overwrites for the channel.

Type:

(readonly) type :Number

Description:

  • The type of channel.

Source:

The type of channel.

Type:
  • Number

Methods

toJSON(format) → {Object}

Description:

  • Returns the JSON representation of this structure.

Source:
Parameters:
Name Type Description
format Number

The format to return the data in.
Returns:
Type
Object

toString()

Source: