Nostrum v0.4.1 Nostrum.Struct.Invite View Source
Struct representing a Discord invite.
Link to this section Summary
Types
The channel this invite is for.
The invite code (unique ID).
When this invite was created.
An invite with metadata.
The guild this invite is for.
The user who created this invite.
Duration (in seconds) after which the invite expires.
Max number of times this invite can be used.
Whether this invite is revoked.
An invite without metadata.
Whether this invite only grants temporary membership.
Number of times this invite has been used.
Link to this section Types
channel()
View Source
channel() :: Nostrum.Struct.Channel.t()
channel() :: Nostrum.Struct.Channel.t()
The channel this invite is for.
code()
View Source
code() :: String.t()
code() :: String.t()
The invite code (unique ID).
created_at()
View Source
created_at() :: String.t()
created_at() :: String.t()
When this invite was created.
detailed_invite() View Source
An invite with metadata.
guild()
View Source
guild() :: Nostrum.Struct.Guild.t()
guild() :: Nostrum.Struct.Guild.t()
The guild this invite is for.
inviter()
View Source
inviter() :: Nostrum.Struct.User.t()
inviter() :: Nostrum.Struct.User.t()
The user who created this invite.
max_age()
View Source
max_age() :: integer()
max_age() :: integer()
Duration (in seconds) after which the invite expires.
max_uses()
View Source
max_uses() :: integer()
max_uses() :: integer()
Max number of times this invite can be used.
revoked()
View Source
revoked() :: boolean()
revoked() :: boolean()
Whether this invite is revoked.
simple_invite() View Source
An invite without metadata.
t()
View Source
t() :: simple_invite() | detailed_invite()
t() :: simple_invite() | detailed_invite()
temporary()
View Source
temporary() :: boolean()
temporary() :: boolean()
Whether this invite only grants temporary membership.
uses()
View Source
uses() :: integer()
uses() :: integer()
Number of times this invite has been used.