Nostrum
v0.8.0

View Source Nostrum.Struct.User.Flags (Nostrum v0.8.0)

Struct representing the flags a user account can have

Link to this section Summary

Types

bug_hunter_level_1()

Bug Hunter (Level 1)

bug_hunter_level_2()

Bug Hunter (Level 2)

early_supporter()

Early Supporter

flags()
hypesquad_balance()

HypeSquad Balance

hypesquad_bravery()

HypeSquad Bravery

hypesquad_brilliance()

HypeSquad Brilliance

hypesquad_events()

HypeSquad Events

partner()

Discord Partner

staff()

Discord Employee

system()

System user

t()
team_user()

Team User

verified_bot()

Verified bot

verified_developer()

Verified developer

Functions

from_integer(flag_value)

Constructs a flag struct based on an integer from the Discord API (either public_flags or flags).

to_integer(flag_struct)

Convert a flag struct to an integer value.

Link to this section Types

Link to this type

bug_hunter_level_1()

View Source 
@type bug_hunter_level_1() :: boolean()

Bug Hunter (Level 1)

Link to this type

bug_hunter_level_2()

View Source 
@type bug_hunter_level_2() :: boolean()

Bug Hunter (Level 2)

Link to this type

early_supporter()

View Source 
@type early_supporter() :: boolean()

Early Supporter

Link to this type

flags()

View Source 
@type flags() :: %Nostrum.Struct.User.Flags{
  bug_hunter_level_1: bug_hunter_level_1(),
  bug_hunter_level_2: bug_hunter_level_2(),
  early_supporter: early_supporter(),
  hypesquad_balance: hypesquad_balance(),
  hypesquad_bravery: hypesquad_bravery(),
  hypesquad_brilliance: hypesquad_brilliance(),
  hypesquad_events: hypesquad_events(),
  partner: partner(),
  staff: staff(),
  system: system(),
  team_user: team_user(),
  verified_bot: verified_bot(),
  verified_developer: verified_developer()
}
Link to this type

hypesquad_balance()

View Source 
@type hypesquad_balance() :: boolean()

HypeSquad Balance

Link to this type

hypesquad_bravery()

View Source 
@type hypesquad_bravery() :: boolean()

HypeSquad Bravery

Link to this type

hypesquad_brilliance()

View Source 
@type hypesquad_brilliance() :: boolean()

HypeSquad Brilliance

Link to this type

hypesquad_events()

View Source 
@type hypesquad_events() :: boolean()

HypeSquad Events

Link to this type

partner()

View Source 
@type partner() :: boolean()

Discord Partner

Link to this type

staff()

View Source 
@type staff() :: boolean()

Discord Employee

Link to this type

system()

View Source 
@type system() :: boolean()

System user

Link to this type

t()

View Source 
@type t() :: flags()
Link to this type

team_user()

View Source 
@type team_user() :: boolean()

Team User

Link to this type

verified_bot()

View Source 
@type verified_bot() :: boolean()

Verified bot

Link to this type

verified_developer()

View Source 
@type verified_developer() :: boolean()

Verified developer

Link to this section Functions

Link to this function

from_integer(flag_value)

View Source 
@spec from_integer(integer()) :: t()

Constructs a flag struct based on an integer from the Discord API (either public_flags or flags).

examples

 Examples 

iex> Nostrum.Struct.User.Flags.from_integer(131842)
%Nostrum.Struct.User.Flags{
  bug_hunter_level_1: false,
  bug_hunter_level_2: false,
  early_supporter: true,
  hypesquad_balance: true,
  hypesquad_bravery: false,
  hypesquad_brilliance: false,
  hypesquad_events: false,
  partner: true,
  staff: false,
  system: false,
  team_user: false,
  verified_bot: false,
  verified_developer: true
}
Link to this function

to_integer(flag_struct)

View Source 
@spec to_integer(t()) :: integer()

Convert a flag struct to an integer value.

examples

 Examples 

iex> my_flags = %Nostrum.Struct.User.Flags{
...>  bug_hunter_level_1: false,
...>  bug_hunter_level_2: false,
...>  early_supporter: true,
...>  hypesquad_balance: true,
...>  hypesquad_bravery: false,
...>  hypesquad_brilliance: false,
...>  hypesquad_events: false,
...>  partner: true,
...>  staff: false,
...>  system: false,
...>  team_user: false,
...>  verified_bot: false,
...>  verified_developer: true
...> }
iex> Nostrum.Struct.User.Flags.to_integer(my_flags)
131842