crux_structs v0.1.6 Crux.Structs.Role View Source

Represents a Discord Role Object.

Link to this section Summary

Types

t()

Functions

create(data)

Creates a Crux.Structs.Role struct from raw data

to_mention(role)

Converts a Crux.Structs.Role into its discord mention format

Link to this section Types

t() (since 0.1.0)

t() :: %Crux.Structs.Role{
  color: integer(),
  guild_id: Crux.Rest.snowflake(),
  hoist: boolean(),
  id: Crux.Rest.snowflake(),
  managed: boolean(),
  mentionable: boolean(),
  name: String.t(),
  permissions: integer(),
  position: integer()
}

Link to this section Functions

create(data) (since 0.1.0)

Creates a Crux.Structs.Role struct from raw data.

Automatically invoked by Crux.Structs.create/2.

to_mention(role) (since 0.1.1)

to_mention(user :: Crux.Structs.Role.t()) :: String.t()

Converts a Crux.Structs.Role into its discord mention format.

## Example

iex> %Crux.Structs.Role{id: 376146940762783746}
...> |> Crux.Structs.Role.to_mention()
"<@&376146940762783746>"