Nostrum.Struct.Guild.Member.Flags (nostrum v0.11.0-dev)

View Source

Struct representing the flags a guild member can have.

Summary

Types

bypasses_verification()

Member is exempt from guild verification requirements

completed_onboarding()

Member has completed onboarding

did_rejoin()

Member has left and rejoined the guild

flags()
started_onboarding()

Member has started onboarding

t()

Functions

from_integer(flag_value)

Constructs a flag struct based on an integer from the Discord API, normally from Nostrum.Struct.Guild.Member.flags/0.

to_integer(flag_struct)

Convert a flag struct to an integer value.

Types

bypasses_verification()

(since 0.9.1) 
@type bypasses_verification() :: boolean()

Member is exempt from guild verification requirements

completed_onboarding()

(since 0.9.1) 
@type completed_onboarding() :: boolean()

Member has completed onboarding

did_rejoin()

(since 0.9.1) 
@type did_rejoin() :: boolean()

Member has left and rejoined the guild

flags()

(since 0.9.1) 
@type flags() :: %Nostrum.Struct.Guild.Member.Flags{
  bypasses_verification: bypasses_verification(),
  completed_onboarding: completed_onboarding(),
  did_rejoin: did_rejoin(),
  started_onboarding: started_onboarding()
}

started_onboarding()

(since 0.9.1) 
@type started_onboarding() :: boolean()

Member has started onboarding

t()

(since 0.9.1) 
@type t() :: flags()

Functions

from_integer(flag_value)

(since 0.9.1) 
@spec from_integer(integer()) :: t()

Constructs a flag struct based on an integer from the Discord API, normally from Nostrum.Struct.Guild.Member.flags/0.

Examples 

iex> Nostrum.Struct.Guild.Member.Flags.from_integer(9)
%Nostrum.Struct.Guild.Member.Flags{
  did_rejoin: true,
  completed_onboarding: false,
  bypasses_verification: false,
  started_onboarding: true
}

to_integer(flag_struct)

(since 0.9.1) 
@spec to_integer(t()) :: integer()

Convert a flag struct to an integer value.

Examples 

iex> my_flags = %Nostrum.Struct.Guild.Member.Flags{
...>   did_rejoin: true,
...>   completed_onboarding: false,
...>   bypasses_verification: false,
...>   started_onboarding: true
...> }
iex> Nostrum.Struct.Guild.Member.Flags.to_integer(my_flags)
9