Skip to content
SinisterRectus edited this page Nov 5, 2016 · 15 revisions

Represents a Discord invitation for joining guilds.

Properties Inherited From Container

Name Type Mutable Description
client Client Client object to which the Discord object is known
parent * Parent Discord object

Class Properties

Name Type Mutable Description
channelId string Snowflake ID of the channel for which the invite exists
channelName string Name of the channel for which the invite exists
channelType string Type of the channel for which the invite exists
code string Invite identifying code
createdAt string When the invite was created
guildId string Snowflake ID of the guild for which the invite exists
guildName string Name of the guild for which the invite exists
inviter User The user that created the invite (nil for widget invites)
maxAge number How many seconds since creation the invite lasts
maxUses number How many times the invite can be used
revoked boolean Whether the invite is revoked and invalid
temporary boolean Whether the invite grants temporary guild membership
uses number How many times this invite has been used

Class Methods

Prototype Description
accept() Joins the guild and channel for which the invite exists (non-bots only).
delete() Revokes and deletes the invite.
Clone this wiki locally