hunter

v0.2.0

hunter v0.2.0 Hunter

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

Summary

Functions

account(conn, id)

Retrieve account

block(conn, id)

Block a user

create_app(name, redirect_uri, scopes \\ "read", website \\ nil)

Register a new OAuth client app on the target instance

create_status(conn, text, in_reply_to_id \\ nil, media_ids \\ [])

Create new status

destroy_status(conn, id)

Destroy status

favourite(conn, id)

Favorite a status

favourites(conn)

Fetch a user’s favourites

follow(conn, id)

Follow a user

follow_by_uri(conn, uri)

Follow a remote user

followers(conn, id)

Get a list of followers

following(conn, id)

Get a list of followed accounts

hashtag_timeline(conn, hashtag, options \\ [])

Retrieve statuses from a hashtag

home_timeline(conn, options \\ [])

Retrieve statuses from the home timeline

mute(conn, id)

Mute a user

new(options \\ [])

Initializes a client

public_timeline(conn, options \\ [])

Retrieve statuses from the public timeline

reblog(conn, id)

Reblog a status

relationships(ids)

Get the relationships of authenticated user towards given other users

search(query, options \\ [])

Search for content

status(conn, id)

Retrieve status

statuses(conn, account_id, options \\ [])

Get a list of statuses by a user

unblock(conn, id)

Unblock a user

unfavourite(conn, id)

Undo a favorite of a status

unfollow(conn, id)

Unfollow a user

unmute(conn, id)

Unmute a user

unreblog(conn, id)

Undo a reblog of a status

upload_media(conn, file)

Upload a media file

user_agent()

User agent of the client

verify_credentials(conn)

Retrieve account of authenticated user

version()

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) 
create_app(String.t, URI.t, String.t, String.t) :: Hunter.Application.t

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
favourites(conn) 
favourites(Hunter.Client.t) :: [Hunter.Status.t]

Fetch a user’s favourites

Parameters

  • conn - connection credentials
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_by_uri(Hunter.Client.t, URI.t) :: Hunter.Account.t

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 \\ []) 
home_timeline(Hunter.Client.t, Keyword.t) :: [Hunter.Status.t]

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 \\ []) 
new(Keyword.t) :: Hunter.Client.t

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(String.t, Keyword.t) :: Hunter.Result.t

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_media(Hunter.Client.t, Path.t) :: Hunter.Attachment.t

Upload a media file

Parameters

  • conn - connection credentials
  • file - media to be uploaded
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