Represents a forum channel.
Extends
ThreadOnlyChannelThe set of tags that can be used in this channel.
Inherited from ThreadOnlyChannelThe time the channel was created at
Inherited from GuildChannelThe timestamp the channel was created at
Inherited from GuildChannelThe default auto archive duration for newly created threads in this channel.
Inherited from ThreadOnlyChannelThe emoji to show in the add reaction button on a thread in a guild forum channel
Inherited from ThreadOnlyChannelThe default sort order mode used to order posts
Inherited from ThreadOnlyChannelThe initial rate limit per user (slowmode) to set on newly created threads in a channel.
Inherited from ThreadOnlyChannelWhether the channel is deletable by the client user
Inherited from GuildChannelThe flags that are applied to the channel. This is only
Inherited from GuildChannelnull
in a PartialGroupDMChannel. In all other cases, it is not null
.The guild the channel is in
Inherited from GuildChannelThe id of the guild the channel is in
Inherited from GuildChannelThe channel's id
Inherited from BaseChannelWhether the channel is manageable by the client user
Inherited from GuildChannelA collection of cached members of this channel, mapped by their ids. Members that can view this channel, if the channel is text-based. Members in the channel, if the channel is voice-based.
Inherited from GuildChannelThe name of the guild channel
Inherited from GuildChannelIf this channel is considered NSFW.
Inherited from ThreadOnlyChannelThe category parent of this channel
Inherited from GuildChannelThe id of the category parent of this channel
Inherited from GuildChannelWhether this Channel is a partial This is always false outside of DM channels.
Inherited from BaseChannelA manager of permission overwrites that belong to this channel
Inherited from GuildChannelIf the permissionOverwrites match the parent channel, null if no parent
Inherited from GuildChannelThe position of the channel
Inherited from GuildChannelThe rate limit per user (slowmode) for this channel.
Inherited from ThreadOnlyChannelThe raw position of the channel from Discord
Inherited from GuildChannelA manager of the threads belonging to this channel
Inherited from ThreadOnlyChannelThe topic of this channel.
Inherited from ThreadOnlyChannelThe type of the channel
The URL to the channel
Inherited from BaseChannelWhether the channel is viewable by the client user
Inherited from GuildChannelClones this channel.
Name | Type | Optional | Description |
---|---|---|---|
options | GuildChannelCloneOptions | Yes | The options for cloning this channel |
Creates an invite to this guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | InviteCreateOptions | Yes | The options for creating the invite |
Creates a webhook for the channel.
Returns
Returns the created Webhook *Example
Name | Type | Optional | Description |
---|---|---|---|
options | ChannelWebhookCreateOptions | Yes | Options for creating the webhook |
Deletes this channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
reason | string | Yes | Reason for deleting this channel |
Edits the channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | GuildChannelEditOptions | No | The options to provide |
Checks if this channel has the same type, topic, position, name, overwrites, and id as another channel. In most cases, a simple
channel.id === channel2.id
will do, and is much faster too.Name | Type | Optional | Description |
---|---|---|---|
channel | GuildChannel | No | Channel to compare with |
Fetches this channel.
Name | Type | Optional | Description |
---|---|---|---|
force | boolean | Yes | Whether to skip the cache check and request the API |
Fetches a collection of invites to this guild channel. Resolves with a collection mapping invites by their codes.
Name | Type | Optional | Description |
---|---|---|---|
cache | boolean | Yes | Whether to cache the fetched invites |
Fetches all webhooks for the channel.
Inherited from ThreadOnlyChannelExample
Indicates whether this channel is DM-based (either a or a PartialGroupDMChannel).
Inherited from BaseChannelIndicates whether this channel is sendable.
Inherited from BaseChannelIndicates whether this channel is text-based.
Inherited from GuildChannelIndicates whether this channel is a .
Inherited from BaseChannelIndicates whether this channel is .
Inherited from BaseChannelIndicates whether this channel is .
Inherited from BaseChannelLocks in the permission overwrites from the parent channel.
Inherited from GuildChannelGets the overall set of permissions for a member or role in this channel, taking into account channel overwrites.
Returns
Name | Type | Optional | Description |
---|---|---|---|
memberOrRole | GuildMember | Role | No | The member or role to obtain the overall permissions for |
checkAdmin | boolean | Yes | Whether having the PermissionFlagsBits.Administrator permission will return all permissions |
Sets the available tags for this forum channel
Name | Type | Optional | Description |
---|---|---|---|
availableTags | readonly GuildForumTagData[] | No | The tags to set as available in this channel |
reason | string | Yes | Reason for changing the available tags |
Sets the default auto archive duration for all newly created threads in this channel.
Name | Type | Optional | Description |
---|---|---|---|
defaultAutoArchiveDuration | ThreadAutoArchiveDuration | No | The new default auto archive duration |
reason | string | Yes | Reason for changing the channel's default auto archive duration |
Sets the default forum layout type used to display posts
Name | Type | Optional | Description |
---|---|---|---|
defaultForumLayout | ForumLayoutType | No | The default forum layout type to set on this channel |
reason | string | Yes | Reason for changing the default forum layout |
Sets the default reaction emoji for this channel
Name | Type | Optional | Description |
---|---|---|---|
defaultReactionEmoji | DefaultReactionEmoji | null | No | The emoji to set as the default reaction emoji |
reason | string | Yes | Reason for changing the default reaction emoji |
Sets the default sort order mode used to order posts
Name | Type | Optional | Description |
---|---|---|---|
defaultSortOrder | SortOrderType | null | No | The default sort order mode to set on this channel |
reason | string | Yes | Reason for changing the default sort order |
Sets the default rate limit per user (slowmode) for new threads in this channel
Name | Type | Optional | Description |
---|---|---|---|
defaultThreadRateLimitPerUser | number | No | The rate limit to set on newly created threads in this channel |
reason | string | Yes | Reason for changing the default rate limit |
Sets a new name for the guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
name | string | No | The new name for the guild channel |
reason | string | Yes | Reason for changing the guild channel's name |
Sets whether this channel is flagged as NSFW.
Name | Type | Optional | Description |
---|---|---|---|
nsfw | boolean | Yes | Whether the channel should be considered NSFW |
reason | string | Yes | Reason for changing the channel's NSFW flag |
Sets the parent of this channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
channel | CategoryChannelResolvable | null | No | The category channel to set as the parent |
options | SetParentOptions | Yes | The options for setting the parent |
Sets a new position for the guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
position | number | No | The new position for the guild channel |
options | SetChannelPositionOptions | Yes | Options for setting position |
Sets the rate limit per user (slowmode) for this channel.
Name | Type | Optional | Description |
---|---|---|---|
rateLimitPerUser | number | No | The new rate limit in seconds |
reason | string | Yes | Reason for changing the channel's rate limit |
Sets a new topic for the guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
topic | string | null | No | The new topic for the guild channel |
reason | string | Yes | Reason for changing the guild channel's topic |
When concatenated with a string, this automatically returns the channel's mention instead of the Channel object.
Inherited from GuildChannel