61 lines
1.9 KiB
Elixir
61 lines
1.9 KiB
Elixir
defmodule Hunter.Attachment do
|
|
@moduledoc """
|
|
Attachment entity
|
|
|
|
This module defines a `Hunter.Attachment` struct and the main functions
|
|
for working with Attachments.
|
|
|
|
## Fields
|
|
|
|
* `id` - ID of the attachment
|
|
* `type` - One of: "image", "video", "gifv", "unknown"
|
|
* `url` - URL of the locally hosted version of the image
|
|
* `remote_url` - For remote images, the remote URL of the original image
|
|
* `preview_url` - URL of the preview image
|
|
* `text_url` - Shorter URL for the image, for insertion into text (only
|
|
present on local images)
|
|
* `meta` - May contain subtress `small` and `original`. Images may contain:
|
|
`width`, `height`, `size`, `aspect`, while videos (including `gifv`) may
|
|
contain: `width`, `height`, `frame_rate`, `duration`, and `bitrate`.
|
|
* `description` - attachment description
|
|
|
|
**Note**: When the type is "unknown", it is likely only `remote_url` is
|
|
available and local `url` is missing
|
|
|
|
"""
|
|
alias Hunter.Config
|
|
|
|
@type t :: %__MODULE__{
|
|
id: non_neg_integer,
|
|
type: String.t(),
|
|
url: String.t(),
|
|
remote_url: String.t(),
|
|
preview_url: String.t(),
|
|
text_url: String.t(),
|
|
meta: String.t(),
|
|
description: String.t()
|
|
}
|
|
|
|
@derive [Poison.Encoder]
|
|
defstruct [:id, :type, :url, :remote_url, :preview_url, :text_url, :meta, :description]
|
|
|
|
@doc """
|
|
Upload a media attachment
|
|
|
|
## Parameters
|
|
|
|
* `conn` - connection credentials
|
|
* `file` - media to be uploaded
|
|
* `options` - option list
|
|
|
|
## Options
|
|
* `description` - plain-text description of the media for accessibility (max 420 chars)
|
|
* `focus` - two floating points, comma-delimited.
|
|
|
|
"""
|
|
@spec upload_media(Hunter.Client.t(), Path.t(), Keyword.t()) :: Hunter.Attachment.t()
|
|
def upload_media(conn, file, options \\ []) do
|
|
Config.hunter_api().upload_media(conn, file, options)
|
|
end
|
|
end
|