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.
The name of this channel.
If true, sets the NSFW setting to enabled for 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.
How often (in seconds) users are able to send messages.
The default value of 0 means the feature is disabled for this channel.
Note: Discord calls this "slow-mode".
The topic displayed above this channel.
The type of this channel. Always Channel.Type.GUILD_TEXT.
Bulk-deletes messages from the channel. The bot must have MANAGE_MESSAGES permission in the channel to perform this action.
You must supply no less than 2 and no greater than 100 messages to be deleted.
If any supplied message is older than 2 weeks, the request will fail.
Note: This action, when completed, will fire a discord.Event.MESSAGE_DELETE_BULK event.
If an error occurs, a discord.ApiError exception will be thrown.
An iterable (Array, Set, etc) of message ids to delete.
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 a single discord.Message (by id) from this channel.
If no message is found, the Promise resolves as null.
The id of the message you wish to fetch data for.
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.
Attempts to send a message with additional options (embed, tts, allowedMentions) to this channel.
Note: content OR embed must be set on the options properties.
See discord.Message.OutgoingMessageOptions for descriptions on possible options.
If an error occurs sending this message, a discord.ApiError exception will be thrown.
Outgoing message options.
Attempts to send a simple message from a string to this channel.
Note: If you'd like to send an embed or pass additional options, see discord.Message.OutgoingMessageOptions
If an error occurs sending this message, a discord.ApiError exception will be thrown.
Content to use for the outgoing message.
Attempts to send a message with only a discord.Embed attached.
If an error occurs sending this message, a discord.ApiError exception will be thrown.
The embed object you'd like to send to the channel.
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.
Triggers the *Username* is typing... message to appear near the text input box for users focused on the channel.
The typing indicator will last up to 15 seconds, or until the bot user sends a message in the channel. Whatever comes first.
Typically unused by bots, but can be used to indicate a command response is "loading" or "processing."
Generated using TypeDoc
Pylon SDK Reference
A text chat channel within a discord.Guild.