hunter v0.1.0 Hunter

A Elixir client for Mastodon, a GNU Social compatible micro-blogging service

Summary

Functions

Retrieve account

Block a user

Register a new OAuth client app on the target instance

Destroy status

Favorite a status

Follow a user

Follow a remote user

Get a list of followers

Get a list of followed accounts

Retrieve statuses from a hashtag

Retrieve statuses from the home timeline

Mute a user

Initializes a client

Retrieve statuses from the public timeline

Reblog a status

Get the relationships of authenticated user towards given other users

Search for content

Retrieve status

Get a list of statuses by a user

Unblock a user

Undo a favorite of a status

Unfollow a user

Unmute a user

Undo a reblog of a status

Upload a media file

User agent of the client

Retrieve account of authenticated user

Returns Hunter version

Functions

account(conn, id)
account(Hunter.Client.t, non_neg_integer) :: Hunter.Account.t

Retrieve account

Parameters

  • conn - connection credentials
  • id - account identifier
block(conn, id)
block(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Block a user

Parameters

  • conn - connection credentials
  • id - user identifier
create_app(name, redirect_uri, scopes \\ "read", website \\ nil)

Register a new OAuth client app on the target instance

Parameters

  • name
  • redirect_uri
  • scopes
  • website
create_status(conn, text, in_reply_to_id \\ nil, media_ids \\ [])
create_status(Hunter.Client.t, String.t, non_neg_integer, [non_neg_integer]) :: Hunter.Status.t

Create new status

Parameters

  • conn - connection credentials
  • text - [String]
  • in_reply_to_id - [Integer]
  • media_ids - [Array]
destroy_status(conn, id)
destroy_status(Hunter.Client.t, non_neg_integer) :: boolean

Destroy status

Parameters

  • conn - connection credentials
  • id - status identifier
favourite(conn, id)
favourite(Hunter.Client.t, non_neg_integer) :: Hunter.Status.t

Favorite a status

Parameters

  • conn - connection credentials
  • id - status identifier
follow(conn, id)
follow(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Follow a user

Parameters

  • conn - connection credentials
  • id - user identifier
follow_by_uri(conn, uri)

Follow a remote user

Parameters

  • conn - connection credentials
  • uri - URI of the remote user, in the format of username@domain
followers(conn, id)
followers(Hunter.Client.t, non_neg_integer) :: [Hunter.Account.t]

Get a list of followers

Parameters

  • conn - connection credentials
  • id - account identifier
following(conn, id)
following(Hunter.Client.t, non_neg_integer) :: [Hunter.Account.t]

Get a list of followed accounts

Parameters

  • conn - connection credentials
  • id - account identifier
hashtag_timeline(conn, hashtag, options \\ [])

Retrieve statuses from a hashtag

Parameters

  • conn - connection credentials
  • hashtag - string list

Options

  • max_id - [Integer]
  • since_id - [Integer]
  • limit - [Integer]
home_timeline(conn, options \\ [])

Retrieve statuses from the home timeline

Parameters

  • conn - connection credentials
  • options - option list

Options

  • max_id - [Integer]
  • since_id - [Integer]
  • limit - [Integer]
mute(conn, id)
mute(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Mute a user

Parameters

  • conn - connection credentials
  • id - user identifier
new(options \\ [])

Initializes a client

Options

  • base_url - URL of the instance you want to connect to
  • bearer_token - [String] OAuth access token for your authenticated user
public_timeline(conn, options \\ [])
public_timeline(Hunter.Client.t, Keyword.t) :: [Hunter.Status.t]

Retrieve statuses from the public timeline

Parameters

  • conn - connection credentials
  • options - option list

Options

  • max_id - [Integer]
  • since_id - [Integer]
  • limit - [Integer]
reblog(conn, id)
reblog(Hunter.Client.t, non_neg_integer) :: Hunter.Status.t

Reblog a status

Parameters

  • conn - connection credentials
  • id - status identifier
relationships(ids)
relationships([non_neg_integer]) :: [Hunter.Relationship.t]

Get the relationships of authenticated user towards given other users

Parameters

  • id - list of relationship IDs
search(query, options \\ [])

Search for content

Parameters

  • q - search query

Options

  • resolve - whether to resolve non-local accounts
status(conn, id)
status(Hunter.Client.t, non_neg_integer) :: Hunter.Status.t

Retrieve status

Parameters

  • conn - connection credentials
  • id - status identifier
statuses(conn, account_id, options \\ [])
statuses(Hunter.Client.t, non_neg_integer, Keyword.t) :: [Hunter.Status.t]

Get a list of statuses by a user

Parameters

  • conn - connection credentials -
  • account_id - account identifier
  • options - option list

Options

  • max_id - [Integer]
  • since_id - [Integer]
  • limit - [Integer]
unblock(conn, id)
unblock(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unblock a user

  • conn - connection credentials
  • id - user identifier
unfavourite(conn, id)
unfavourite(Hunter.Client.t, non_neg_integer) :: Hunter.Status.t

Undo a favorite of a status

Parameters

  • conn - connection credentials
  • id - status identifier
unfollow(conn, id)
unfollow(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unfollow a user

Parameters

  • conn - connection credentials
  • id - user identifier
unmute(conn, id)
unmute(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Unmute a user

Parameters

  • conn - connection credentials
  • id - user identifier
unreblog(conn, id)
unreblog(Hunter.Client.t, non_neg_integer) :: Hunter.Status.t

Undo a reblog of a status

Parameters

  • conn - connection credentials
  • id - status identifier
upload_media(conn, file)

Upload a media file

Parameters

  • conn - connection credentials
  • file
user_agent()
user_agent() :: String.t

User agent of the client

verify_credentials(conn)
verify_credentials(Hunter.Client.t) :: Hunter.Account.t

Retrieve account of authenticated user

Parameters

  • conn - connection credentials
version()
version() :: String.t

Returns Hunter version