Nostrum v0.4.1 Nostrum.Struct.Embed View Source
Functions that work on Discord embeds.
Building Embeds
Nostrum.Struct.Embed
s can be built using this module's builder functions
or standard Map
syntax:
iex> import Nostrum.Struct.Embed
...> embed =
...> %Nostrum.Struct.Embed{}
...> |> put_title("craig")
...> |> put_description("nostrum")
...> |> put_url("https://google.com/")
...> |> put_timestamp("2016-05-05T21:04:13.203Z")
...> |> put_color(431_948)
...> |> put_field("Field 1", "Test")
...> |> put_field("Field 2", "More test", true)
...> embed
%Nostrum.Struct.Embed{
title: "craig",
description: "nostrum",
url: "https://google.com/",
timestamp: "2016-05-05T21:04:13.203Z",
color: 431_948,
fields: [
%Nostrum.Struct.Embed.Field{name: "Field 1", value: "Test"},
%Nostrum.Struct.Embed.Field{name: "Field 2", value: "More test", inline: true}
]
}
Link to this section Summary
Types
Author information
Color code of the embed
Description of the embed
Fields information
Footer information
Image information
Provider information
Thumbnail information
Timestamp of embed content
Title of the embed
Type of the embed
Url of the embed
Video information
Functions
Puts a Nostrum.Struct.Embed.Author
under :author
in embed
.
Puts the given value
under :color
in embed
.
Puts the given value
under :description
in embed
.
Adds a Nostrum.Struct.Embed.Field
under :fields
in embed
.
Puts a Nostrum.Struct.Embed.Footer
under :footer
in embed
.
Puts a Nostrum.Struct.Embed.Image
under :image
in embed
.
Puts a Nostrum.Struct.Embed.Thumbnail
under :thumbnail
in embed
.
Puts the given value
under :timestamp
in embed
.
Puts the given value
under :title
in embed
.
Puts the given value
under :url
in embed
.
Link to this section Types
author()
View Source
author() :: Nostrum.Struct.Embed.Author.t() | nil
author() :: Nostrum.Struct.Embed.Author.t() | nil
Author information
color()
View Source
color() :: Integer.t() | nil
color() :: Integer.t() | nil
Color code of the embed
description()
View Source
description() :: String.t() | nil
description() :: String.t() | nil
Description of the embed
fields()
View Source
fields() :: [Nostrum.Struct.Embed.Field.t()] | nil
fields() :: [Nostrum.Struct.Embed.Field.t()] | nil
Fields information
image()
View Source
image() :: Nostrum.Struct.Embed.Image.t() | nil
image() :: Nostrum.Struct.Embed.Image.t() | nil
Image information
provider()
View Source
provider() :: Nostrum.Struct.Embed.Provider.t() | nil
provider() :: Nostrum.Struct.Embed.Provider.t() | nil
Provider information
thumbnail()
View Source
thumbnail() :: Nostrum.Struct.Embed.Thumbnail.t() | nil
thumbnail() :: Nostrum.Struct.Embed.Thumbnail.t() | nil
Thumbnail information
timestamp()
View Source
timestamp() :: String.t() | nil
timestamp() :: String.t() | nil
Timestamp of embed content
title()
View Source
title() :: String.t() | nil
title() :: String.t() | nil
Title of the embed
type()
View Source
type() :: String.t() | nil
type() :: String.t() | nil
Type of the embed
url()
View Source
url() :: String.t() | nil
url() :: String.t() | nil
Url of the embed
video()
View Source
video() :: Nostrum.Struct.Embed.Video.t() | nil
video() :: Nostrum.Struct.Embed.Video.t() | nil
Video information
Link to this section Functions
put_author(embed, name, url, icon_url)
View Source
put_author(
t(),
Nostrum.Struct.Embed.Author.name(),
Nostrum.Struct.Embed.Author.url(),
Nostrum.Struct.Embed.Author.icon_url()
) :: t()
put_author( t(), Nostrum.Struct.Embed.Author.name(), Nostrum.Struct.Embed.Author.url(), Nostrum.Struct.Embed.Author.icon_url() ) :: t()
Puts a Nostrum.Struct.Embed.Author
under :author
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_author(embed, "skippi", "https://github.com/skippi", nil)
%Nostrum.Struct.Embed{
author: %Nostrum.Struct.Embed.Author{
name: "skippi",
url: "https://github.com/skippi",
icon_url: nil
}
}
put_color(embed, value) View Source
Puts the given value
under :color
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_color(embed, 431948)
%Nostrum.Struct.Embed{color: 431948}
put_description(embed, value)
View Source
put_description(t(), description()) :: t()
put_description(t(), description()) :: t()
Puts the given value
under :description
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_description(embed, "An elixir library for the discord API.")
%Nostrum.Struct.Embed{description: "An elixir library for the discord API."}
put_field(embed, name, value, inline \\ nil)
View Source
put_field(
t(),
Nostrum.Struct.Embed.Field.name(),
Nostrum.Struct.Embed.Field.value(),
Nostrum.Struct.Embed.Field.inline()
) :: t()
put_field( t(), Nostrum.Struct.Embed.Field.name(), Nostrum.Struct.Embed.Field.value(), Nostrum.Struct.Embed.Field.inline() ) :: t()
Adds a Nostrum.Struct.Embed.Field
under :fields
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_field(embed, "First User", "b1nzy")
%Nostrum.Struct.Embed{
fields: [
%Nostrum.Struct.Embed.Field{name: "First User", value: "b1nzy"}
]
}
iex> embed = %Nostrum.Struct.Embed{
...> fields: [
...> %Nostrum.Struct.Embed.Field{name: "First User", value: "b1nzy"}
...> ]
...> }
...> Nostrum.Struct.Embed.put_field(embed, "Second User", "Danny")
%Nostrum.Struct.Embed{
fields: [
%Nostrum.Struct.Embed.Field{name: "First User", value: "b1nzy"},
%Nostrum.Struct.Embed.Field{name: "Second User", value: "Danny"}
]
}
put_image(embed, url)
View Source
put_image(t(), Nostrum.Struct.Embed.Image.url()) :: t()
put_image(t(), Nostrum.Struct.Embed.Image.url()) :: t()
Puts a Nostrum.Struct.Embed.Image
under :image
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_image(embed, "https://discordapp.com/assets/af92e60c16b7019f34a467383b31490a.svg")
%Nostrum.Struct.Embed{
image: %Nostrum.Struct.Embed.Image{
url: "https://discordapp.com/assets/af92e60c16b7019f34a467383b31490a.svg"
}
}
put_thumbnail(embed, url)
View Source
put_thumbnail(t(), Nostrum.Struct.Embed.Thumbnail.url()) :: t()
put_thumbnail(t(), Nostrum.Struct.Embed.Thumbnail.url()) :: t()
Puts a Nostrum.Struct.Embed.Thumbnail
under :thumbnail
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_thumbnail(embed, "https://discordapp.com/assets/af92e60c16b7019f34a467383b31490a.svg")
%Nostrum.Struct.Embed{
thumbnail: %Nostrum.Struct.Embed.Thumbnail{
url: "https://discordapp.com/assets/af92e60c16b7019f34a467383b31490a.svg"
}
}
put_timestamp(embed, value) View Source
Puts the given value
under :timestamp
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_timestamp(embed, "2018-04-21T17:33:51.893000Z")
%Nostrum.Struct.Embed{timestamp: "2018-04-21T17:33:51.893000Z"}
put_title(embed, value) View Source
Puts the given value
under :title
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_title(embed, "nostrum")
%Nostrum.Struct.Embed{title: "nostrum"}
put_url(embed, value) View Source
Puts the given value
under :url
in embed
.
Examples
iex> embed = %Nostrum.Struct.Embed{}
...> Nostrum.Struct.Embed.put_url(embed, "https://github.com/Kraigie/nostrum")
%Nostrum.Struct.Embed{url: "https://github.com/Kraigie/nostrum"}