DiscordLua
discorddiscord
v1.2.4
Install

CategoryChannel

channel
On this page

CategoryChannel is a DiscordLua channel representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

channel Module 1.2.4 Source
Inheritance
  1. CategoryChannel
  2. GuildChannel
  3. Channel
Inherited properties (45)
appliedTags · inherited from Channelarchived · inherited from ChannelarchiveTimestamp · inherited from ChannelautoArchiveDuration · inherited from ChannelavailableTags · inherited from Channelbitrate · inherited from Channelchildren · inherited from Channelclient · inherited from ChanneldefaultAutoArchiveDuration · inherited from ChanneldefaultForumLayout · inherited from ChanneldefaultReactionEmoji · inherited from ChanneldefaultSortOrder · inherited from ChanneldefaultThreadRateLimitPerUser · inherited from Channelflags · inherited from ChannelguildId · inherited from Channelicon · inherited from Channelid · inherited from Channelinvitable · inherited from Channelinvites · inherited from ChannellastMessageId · inherited from ChannellastPinTimestamp · inherited from Channellocked · inherited from ChannelmemberCount · inherited from Channelmembers · inherited from ChannelmessageCount · inherited from Channelmessages · inherited from Channelname · inherited from Channelnsfw · inherited from ChannelownerId · inherited from ChannelparentId · inherited from ChannelpermissionOverwrites · inherited from Channelposition · inherited from ChannelrateLimitPerUser · inherited from Channelraw · inherited from Channelrecipient · inherited from ChannelrecipientId · inherited from ChannelrecipientIds · inherited from Channelrecipients · inherited from ChannelrtcRegion · inherited from Channelthreads · inherited from Channeltopic · inherited from ChanneltotalMessageSent · inherited from Channeltype · inherited from ChanneluserLimit · inherited from ChannelvideoQualityMode · inherited from Channel

Methods

CategoryChannel:children()

#

Performs children on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:children()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:children()

CategoryChannel:deletable()

#

Performs deletable on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:deletable()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:deletable()

CategoryChannel:manageable()

#

Performs manageable on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:manageable()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:manageable()

CategoryChannel:parent()

#

Performs parent on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:parent()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:parent()

CategoryChannel:permissionsLocked()

#

Performs permissions locked on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:permissionsLocked()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:permissionsLocked()

CategoryChannel:rawPosition()

#

Performs raw position on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:rawPosition()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:rawPosition()

CategoryChannel:viewable()

#

Performs viewable on this CategoryChannel. Call it from bot code when you need that operation on the current object.

Signature

CategoryChannel:viewable()

Parameters

No parameters.

Returns

CategoryChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a CategoryChannel
object:viewable()
Inherited methods (47)

Examples

Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.

BaseGuildTextChannel · BaseGuildVoiceChannel · Channel · DirectoryChannel · DMChannel · ForumChannel · GuildChannel · MediaChannel

Version: discord 1.2.4 · runtime 1.0.0

Search Ctrl K Navigate Open Esc