Inherits Container

Represents an invitation to a Discord guild channel. Invites can be used to join a guild, though they are not always permanent.

delete

code
guildId
guildName
channelId
channelName
channelType
guildIcon
guildSplash
guildIconURL
guildSplashURL
inviter
uses
maxUses
maxAge
temporary
createdAt
revoked
approximatePresenceCount
approximateMemberCount

Inherited from Container
client
parent

Permanently deletes the invite. This cannot be undone!

Returns: boolean

The invite's code which can be used to identify the invite.

Type: string

The Snowflake ID of the guild to which this invite belongs.

Type: string

The name of the guild to which this invite belongs.

Type: string

The Snowflake ID of the channel to which this belongs.

Type: string

The name of the channel to which this invite belongs.

Type: string

The type of the channel to which this invite belongs. Use the channelType enumeration for a human-readable representation.

Type: number

The hash for the guild's custom icon, if one is set.

Type: string|nil

The hash for the guild's custom splash, if one is set.

Type: string|nil

The URL that can be used to view the guild's icon, if one is set.

Type: string|nil

The URL that can be used to view the guild's splash, if one is set.

Type: string|nil

The object of the user that created the invite. This will not exist if the invite is a guild widget or a vanity invite.

Type: User|nil

How many times this invite has been used. This will not exist if the invite is accessed via Client:getInvite.

Type: number|nil

The maximum amount of times this invite can be used. This will not exist if the invite is accessed via Client:getInvite.

Type: number|nil

How long, in seconds, this invite lasts before it expires. This will not exist if the invite is accessed via Client:getInvite.

Type: number|nil

Whether the invite grants temporary membership. This will not exist if the invite is accessed via Client:getInvite.

Type: boolean|nil

The date and time at which the invite was created, represented as an ISO 8601 string plus microseconds when available. This will not exist if the invite is accessed via Client:getInvite.

Type: string

Whether the invite has been revoked. This will not exist if the invite is accessed via Client:getInvite.

Type: boolean|nil

The approximate count of online members.

Type: number|nil

The approximate count of all members.

Type: number|nil

A shortcut to the client object to which this container is visible.

Type: Client

The parent object of to which this container is a child. For example, the parent of a role is the guild in which the role exists.

Type: Container|Client