crux_structs v0.2.3 Crux.Structs.Embed View Source
Represents a Discord Embed Object.
Every property except type is optional, and thus may have default value.
Link to this section Summary
Link to this section Types
Specs
t() :: %Crux.Structs.Embed{
author:
%{
optional(:name) => String.t(),
optional(:url) => String.t(),
optional(:icon_url) => String.t(),
optional(:proxy_icon_url) => String.t()
}
| nil,
color: integer() | nil,
description: String.t() | nil,
fields: [
%{:name => String.t(), :value => String.t(), optional(:inline) => boolean()}
],
footer:
%{
optional(:text) => String.t(),
optional(:icon_url) => String.t(),
optional(:proxy_icon_url) => String.t()
}
| nil,
image:
%{
optional(:url) => String.t(),
optional(:proxy_url) => String.t(),
optional(:height) => integer(),
optional(:width) => integer()
}
| nil,
provider:
%{optional(:name) => String.t(), optional(:url) => String.t()} | nil,
thumbnail:
%{
optional(:url) => String.t(),
optional(:proxy_url) => String.t(),
optional(:height) => integer(),
optional(:width) => integer()
}
| nil,
timestamp: String.t() | nil,
title: String.t() | nil,
type: String.t() | nil,
url: String.t() | nil,
video:
%{
optional(:url) => String.t(),
optional(:height) => integer(),
optional(:width) => integer()
}
| nil
}