hunter

v0.5.1

hunter v0.5.1 Hunter.Card View Source

Card entity

This module defines a Hunter.Card struct and the main functions for working with Cards

Fields

  • url- the url associated with the card
  • title - the title of the card
  • description - the card description
  • image - the image associated with the card, if any
  • type - link, photo, video, or rich
  • author_name - name of the author/owner of the resource
  • author_url - URL for the author/owner of the resource
  • provider_name - name of the resource provider
  • provider_url - url of the resource provider
  • html - HTML required to display the resource
  • width - width in pixels
  • height - height in pixels

Link to this section Summary

Types

t()

Functions

card_by_status(conn, id)

Retrieve a card associated with a status

Link to this section Types

Link to this type

t() View Source 
t() :: %Hunter.Card{
  author_name: String.t(),
  author_url: String.t(),
  description: String.t(),
  height: non_neg_integer(),
  html: String.t(),
  image: String.t(),
  provider_name: String.t(),
  provider_url: String.t(),
  title: String.t(),
  type: String.t(),
  url: String.t(),
  width: non_neg_integer()
}

Link to this section Functions

Link to this function

card_by_status(conn, id) View Source 
card_by_status(Hunter.Client.t(), non_neg_integer()) :: Hunter.Card.t()

Retrieve a card associated with a status

Parameters

  • conn - connection credentials
  • id - status id

Examples 

iex> conn = Hunter.new([base_url: "https://social.lou.lt", bearer_token: "123456"])
%Hunter.Client{base_url: "https://social.lou.lt", bearer_token: "123456"}
iex> Hunter.Card.card_by_status(conn, 118_635)
%Hunter.Card{description: "hunter - A Elixir client for Mastodon, a GNU Social compatible micro-blogging service",
          image: "https://social.lou.lt/system/preview_cards/images/000/000/378/original/34700?1491626499",
          title: "milmazz/hunter", url: "https://github.com/milmazz/hunter"}