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.

t()

Whether this invite only grants temporary membership.

Number of times this invite has been used.

Link to this section Types

The channel this invite is for.

The invite code (unique ID).

Link to this type

created_at() View Source
created_at() :: String.t()

When this invite was created.

Link to this type

detailed_invite() View Source
detailed_invite() :: %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()
}

An invite with metadata.

The guild this invite is for.

The user who created this invite.

Duration (in seconds) after which the invite expires.

Link to this type

max_uses() View Source
max_uses() :: integer()

Max number of times this invite can be used.

Whether this invite is revoked.

Link to this type

simple_invite() View Source
simple_invite() :: %Nostrum.Struct.Invite{
  channel: channel(),
  code: code(),
  created_at: nil,
  guild: guild(),
  inviter: inviter(),
  max_age: nil,
  max_uses: nil,
  revoked: nil,
  temporary: nil,
  uses: nil
}

An invite without metadata.

Link to this type

temporary() View Source
temporary() :: boolean()

Whether this invite only grants temporary membership.

Number of times this invite has been used.