crux_structs v0.2.0 Crux.Structs.Guild View Source

Represents a Discord Guild Object.

Differences opposed to the Discord API Object:

:emojis is a MapSet of emoji ids
:channels is a MapSet of channel ids
:presences does not exists at all

Link to this section Summary

Types

t()

Functions

create(data)

Creates a Crux.Structs.Guild struct from raw data

Link to this section Types

t() (since 0.1.0)

t() :: %Crux.Structs.Guild{
  afk_channel_id: Crux.Rest.snowflake() | nil,
  afk_timeout: integer(),
  application_id: Crux.Rest.snowflake() | nil,
  banner: String.t() | nil,
  channels: MapSet.t(Crux.Rest.snowflake()),
  default_message_notifications: integer(),
  description: String.t() | nil,
  embed_enabled: boolean(),
  emojis: MapSet.t(Crux.Rest.snowflake()),
  explicit_content_filter: integer(),
  features: MapSet.t(String.t()),
  icon: String.t() | nil,
  id: Crux.Rest.snowflake(),
  joined_at: String.t(),
  large: boolean(),
  max_members: pos_integer(),
  max_presences: pos_integer() | nil,
  member_count: integer(),
  members: %{optional(Crux.Rest.snowflake()) => Crux.Structs.Member.t()},
  mfa_level: integer(),
  name: String.t(),
  owner_id: String.t(),
  region: String.t(),
  roles: %{optional(Crux.Rest.snowflake()) => Crux.Structs.Role.t()},
  splash: term(),
  unavailable: boolean(),
  vanity_url_code: String.t() | nil,
  verification_level: integer(),
  voice_states: %{
    optional(Crux.Rest.snowflake()) => Crux.Structs.VoiceState.t()
  },
  widget_enabled: boolean()
}

Link to this section Functions

create(data) (since 0.1.0)

create(data :: map()) :: t()

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

Automatically invoked by Crux.Structs.create/2.

v0.2.0