View Source Nostrum.Struct.Event.InviteCreate (Nostrum v0.6.1)

Struct representing an Invite Create event

Link to this section Summary

Types

Channel id of the channel this invite is for.

The unique invite code.

The time at which the invite was created.

Guild id of the guild this invite is for.

The user that created the invite.

Duration (in seconds) after which the invite expires.

Max number of times this invite can be used.

t()

Partially populated user struct of the target user for this invite.

The type of user target for this invite.

Whether this invite only grants temporary membership.

Number of times this invite has been used.

Link to this section Types

Specs

channel_id() :: Nostrum.Struct.Channel.id()

Channel id of the channel this invite is for.

Specs

code() :: String.t()

The unique invite code.

Specs

created_at() :: String.t()

The time at which the invite was created.

Specs

guild_id() :: Nostrum.Struct.Guild.id() | nil

Guild id of the guild this invite is for.

Specs

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

The user that created the invite.

Specs

max_age() :: integer()

Duration (in seconds) after which the invite expires.

Specs

max_uses() :: integer()

Max number of times this invite can be used.

Specs

t() :: %Nostrum.Struct.Event.InviteCreate{
  channel_id: channel_id(),
  code: code(),
  created_at: created_at(),
  guild_id: guild_id(),
  inviter: inviter(),
  max_age: max_age(),
  max_uses: max_uses(),
  target_user: target_user(),
  target_user_type: target_user_type(),
  temporary: temporary(),
  uses: uses()
}

Specs

target_user() :: Nostrum.Struct.User.t() | nil

Partially populated user struct of the target user for this invite.

Specs

target_user_type() :: integer() | nil

The type of user target for this invite.

Specs

temporary() :: boolean()

Whether this invite only grants temporary membership.

Specs

uses() :: integer()

Number of times this invite has been used.