Elixir v0.2.0 Nostrum.Struct.Invite

Struct representing a Discord invite.

Summary

Types

Channel the invite is for

Invite code

When the invite was created

Guild the invite is for

User who created the invite

Duration in seconds after which the invite expires

Number of times this invite can be used

Whether the invite is revoked

t()

Whether the invite gives temporary membership

Number of times this invite has been used

Types

channel()

Channel the invite is for

code()
code() :: String.t

Invite code

created_at()
created_at() :: String.t

When the invite was created

Guild the invite is for

inviter()
inviter() :: Nostrum.Struct.User.t

User who created the invite

max_age()
max_age() :: integer

Duration in seconds after which the invite expires

max_uses()
max_uses() :: integer

Number of times this invite can be used

revoked()
revoked() :: boolean

Whether the invite is revoked

t()
t() :: %Nostrum.Struct.Invite{channel: channel, code: code, created_at: created_at, guild: guild, inviter: inviter, max_age: max_age, max_uses: max_uses, revoked: revoked, temporary: temporary, uses: uses}
temporary()
temporary() :: boolean

Whether the invite gives temporary membership

uses()
uses() :: integer

Number of times this invite has been used