Hunter.Attachment (hunter v0.6.0)

Copy Markdown View Source

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

Summary

Types

t()

Functions

upload_media(conn, file, options \\ [])

Upload a media attachment

Types

t()

@type t() :: %Hunter.Attachment{
  description: String.t(),
  id: non_neg_integer(),
  meta: String.t(),
  preview_url: String.t(),
  remote_url: String.t(),
  text_url: String.t(),
  type: String.t(),
  url: String.t()
}

Functions

upload_media(conn, file, options \\ [])

@spec upload_media(Hunter.Client.t(), Path.t(), Keyword.t()) :: t()

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.

Note: the v2 media endpoint processes large files asynchronously: the returned attachment's url may be nil until the server finishes processing (HTTP 202). The id can be attached to a status with create_status as soon as processing completes.