Represents any channel type on Discord.
Represents any channel type on Discord that exists within a discord.Guild.
The id of the discord.Guild this channel resides in.
Discord's unique identifier for this channel. This value never changes.
The name of this channel.
If the channel resides within a discord.GuildCategory, its id is set on this property.
Any member or role-specific permission overwrite settings for this channel.
Note: You should use discord.GuildChannel.getMemberPermissions or the easier discord.GuildChannel.canMember function to test member permissions for a given channel.
The position in the channel list this channel should be displayed at.
The type of this channel. See discord.Channel.AnyGuildChannel for a complete list of guild channel types.
Determines if a member can perform actions that require the permission specified in this channel.
Permissions are calculated off the base member permissions via discord.GuildMember.permissions and the member and role-specific permission overwrites from discord.GuildChannel.permissionOverwrites.
The GuildMember you want to calculate channel-specific permissions for.
The permission you are checking for. Check discord.Permissions for an exhaustive list of all permissions.
true
if the permission is granted, otherwise false
.
Determines if a role can perform actions that require the permission specified in this channel.
The permissions are calculated by finding the role in discord.GuildChannel.permissionOverwrites and applying on top of the everyone role permissions for the channel.
The Role you want to calculate channel-specific permissions for.
The permission you are checking for. Check discord.Permissions for an exhaustive list of all permissions.
true
if the permission is granted, otherwise false
.
Creates an invite for the channel. All properties of the options
parameter are optional.
The settings to use for this invite. All parameters are optional.
Attempts to delete the channel.
If an error occurs, a discord.ApiError exception is thrown.
Attempts to update the given options for this channel.
If an error occurs, a discord.ApiError will be thrown.
The settings to update for this channel.
Fetches the data for the guild this channel belongs to.
Fetches an array of discord.GuildInvite objects associated with this channel.
Returns the calculated member permissions for this channel.
It is calculated off the base member permissions via discord.GuildMember.permissions and the member and role-specific permission overwrites from discord.GuildChannel.permissionOverwrites.
Note: If you just want to see if a member has a permission, use discord.GuildChannel.canMember.
The GuildMember you want to calculate channel-specific permissions for.
The permission bit set calculated for the given member.
Attempts to fetch an instance of the discord.GuildCategory this channel resides in.
If an error occurs, a discord.ApiError will be thrown.
If the channel does not reside in a cateogry, the Promise resolves as null
.
Returns the calculated role permissions for this channel.
The permissions are calculated by finding the role in discord.GuildChannel.permissionOverwrites and applying on top of the everyone role permissions for the channel.
Note: If you just want to see if a role has a permission, use discord.GuildChannel.canRole.
The Role you want to calculate channel-specific permissions for.
The permission bit set calculated for the given role.
Returns a mention string in the format of <#id>
where id is the id of this channel.
Can be used in a message to render a link to this channel.
Generated using TypeDoc
A base class containing properties and methods available for all channels that reside in a guild.
You should never create/receive an instance of this class directly.