crux_structs v0.1.6 Crux.Structs.Channel View Source

Represents a Discord Channel Object.

List of where every property can be present:

Property	Text (0)	DM (1)	Voice (2)	Group (3)	Category (4)
application_id	no	no	no	yes	no
bitrate	no	no	yes	no	no
guild_id	yes	no	yes	no	yes
icon	no	no	no	yes	no
id	yes	yes	yes	yes	yes
last_message_id	yes	yes	no	yes	no
last_pin_timestamp	yes	yes	no	yes	no
name	yes	no	yes	yes	yes
nsfw	yes	no	no	no	no
owner_id	no	no	no	yes	no
parent_id	yes	no	yes	no	no
permission_overwrites	yes	no	yes	no	yes
position	yes	no	yes	no	yes
rate_limit_per_user	yes	no	no	no	no
recipients	no	yes (One Element)	no	yes	no
topic	yes	no	yes	no	yes
type	`0`	`1`	`2`	`3`	`4`
user_limit	no	no	yes	no	no

Differences opposed to the Discord API Object:

:recipients is a MapSet of user ids

Link to this section Summary

Types

t()

Functions

create(data)

Creates a Crux.Structs.Channel struct from raw data

to_mention(channel)

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

Link to this section Types

t() (since 0.1.0)

t() :: %Crux.Structs.Channel{
  application_id: Crux.Rest.snowflake(),
  bitrate: integer(),
  guild_id: Crux.Rest.snowflake(),
  icon: String.t(),
  id: Crux.Rest.snowflake(),
  last_message_id: Crux.Rest.snowflake(),
  last_pin_timestamp: String.t(),
  name: String.t(),
  nsfw: boolean(),
  owner_id: Crux.Rest.snowflake(),
  parent_id: Crux.Rest.snowflake(),
  permission_overwrites: %{
    optional(Crux.Rest.snowflake()) => Crux.Structs.Overwrite.t()
  },
  position: integer(),
  rate_limit_per_user: integer(),
  recipients: MapSet.t(Crux.Rest.snowflake()),
  topic: String.t(),
  type: integer(),
  user_limit: non_neg_integer()
}

Link to this section Functions

create(data) (since 0.1.0)

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

Automatically invoked by Crux.Structs.create/2

to_mention(channel) (since 0.1.1)

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

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

Example

iex> %Crux.Structs.Channel{id: 316880197314019329}
...> |> Crux.Structs.Channel.to_mention()
"<#316880197314019329>"