Remedy.Schema.Emoji (Remedy v0.6.8) View Source

Discord Emoji Object

Link to this section Summary

Types

t()

Functions

api_name(emoji)

Formats an emoji struct into its t:Remedy.Struct.Emoji.api_name/0.

changeset(model \\ %__MODULE__{}, params)

image_url(emoji)

Returns the url of a custom emoji's image. If the emoji is not a custom one, returns nil.

mention(emoji)

Mention is more of a ping. potentially rename

Link to this section Types

t()

Specs

t() :: %Remedy.Schema.Emoji{
  __meta__: term(),
  animated: boolean(),
  available: boolean(),
  guild: Remedy.Schema.Guild.t(),
  guild_id: term(),
  id: term(),
  managed: boolean(),
  name: String.t(),
  require_colons: boolean(),
  user: Remedy.Schema.User.t(),
  user_id: term()
}

Link to this section Functions

api_name(emoji)

Specs

api_name(t()) :: String.t()

Formats an emoji struct into its t:Remedy.Struct.Emoji.api_name/0.

Examples

iex> emoji = %Remedy.Struct.Emoji{name: "Γ¡É"}
...> Remedy.Struct.Emoji.api_name(emoji)
"Γ¡É"

iex> emoji = %Remedy.Struct.Emoji{id: 437093487582642177, name: "foxbot"}
...> Remedy.Struct.Emoji.api_name(emoji)
"foxbot:437093487582642177"

changeset(model \\ %MODULE{}, params)

image_url(emoji)

Specs

image_url(t()) :: String.t() | nil

Returns the url of a custom emoji's image. If the emoji is not a custom one, returns nil.

Examples

iex> emoji = %Remedy.Struct.Emoji{id: 450225070569291776}
...> Remedy.Struct.Emoji.image_url(emoji)
"https://cdn.discordapp.com/emojis/450225070569291776.png"

iex> emoji = %Remedy.Struct.Emoji{id: 406140226998894614, animated: true}
...> Remedy.Struct.Emoji.image_url(emoji)
"https://cdn.discordapp.com/emojis/406140226998894614.gif"

iex> emoji = %Remedy.Struct.Emoji{id: nil, name: "Γ¡É"}
...> Remedy.Struct.Emoji.image_url(emoji)
nil

mention(emoji)

Specs

mention(t()) :: String.t()

Mention is more of a ping. potentially rename

Formats an Remedy.Struct.Emoji into a mention.

Examples

iex> emoji = %Remedy.Struct.Emoji{name: "≡ƒæì"}
...> Remedy.Struct.Emoji.mention(emoji)
"≡ƒæì"

iex> emoji = %Remedy.Struct.Emoji{id: 436885297037312001, name: "tealixir"}
...> Remedy.Struct.Emoji.mention(emoji)
"<:tealixir:436885297037312001>"

iex> emoji = %Remedy.Struct.Emoji{id: 437016804309860372, name: "blobseizure", animated: true}
...> Remedy.Struct.Emoji.mention(emoji)
"<a:blobseizure:437016804309860372>"