Partial channel data present on channel data.
The id of the discord.Channel this data represents.
The name of the channel.
The type of channel the invite resolves to.
Partial guild data present on some invite data.
A list of features available for this guild. See discord.Guild.features for more info.
The icon of the guild, if set. See discord.Guild.icon for more info.
The id of the discord.Guild.
The name of the guild.
The splash image hash of the guild, if set.
The vanity url invite code for this guild, if set.
The level of user account verification required to send messages in this guild without a role.
If the invite is for a guild channel, this number is the approximate total member count for the guild.
Requires that the invite was retrieved with [[discord.Invite.IGetGuildOptions.withCounts]] set to true.
If the invite is for a guild, this includes an approximate count of members online in the guild.
Requires that the invite was retrieved with [[discord.Invite.IGetGuildOptions.withCounts]] set to true.
Partial channel data for this invite.
Users who use this invite will be redirected to the channel id.
The unique identifier for this invite. May be used by user accounts to join a guild or group dm.
Partial guild data for this invite, if relevant.
The user object who created this invite, if relevant.
A user that the invite targets.
Right now, this only indiicates if the invite is for a specific user's go-live stream in a guild's voice channel.
If targetUser is set, this property specifies the type of invite and user this targets.
Right now, the only possible option is discord.Invite.TargetUserType.STREAM.
Tries to delete this invite. The bot user must be able to manage the channel or guild the invite belongs.
If an error occurs, a discord.ApiError will be thrown.
Attempts to retrieve the full Channel object for this invite.
This function will return null if the channel does not belong to the guild the script is running in.
Attempts to retrieve the full Guild object for this invite, if set.
This function will also return null if the channel does not belong to the guild the script is running in.
Returns a url for the invite, in the format: https://discord.gg/<code>.
Generated using TypeDoc
Pylon SDK Reference
An object representing an invite on Discord.
Invites typically appear as links (ex: discord.gg/6DbcNPz) where the code is a unique and random string of alpha-numeric characters.
Since Group DMs may create invites, some properties on the invite object are nullable.