hunter

v0.4.1

hunter v0.4.1 Hunter

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

Summary

Functions

accept_follow_request(conn, id)

Accepts a follow request

account(conn, id)

Retrieve account

block(conn, id)

Block a user

blocks(conn)

Retrieve user’s blocks

card_by_status(conn, id)

Retrieve a card associated with a status

clear_notifications(conn)

Deletes all notifications from the Mastodon server for the authenticated user

create_app(name, redirect_uri \\ "urn:ietf:wg:oauth:2.0:oob", scopes \\ ["read"], website \\ nil, options \\ [])

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

favourited_by(conn, id)

Fetch the list of users who favourited the status

favourites(conn)

Fetch a user’s favourites

follow(conn, id)

Follow a user

follow_by_uri(conn, uri)

Follow a remote user

follow_requests(conn)

Retrieve a list of follow requests

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

instance_info(conn)

Retrieve instance information

load_credentials(name)

Load persisted application’s credentials

log_in(app, username, password, base_url \\ "https://mastodon.social")

Retrieve access token

mute(conn, id)

Mute a user

mutes(conn)

Retrieve user’s mutes

new(options \\ [])

Initializes a client

notification(conn, id)

Retrieve single notification

notifications(conn)

Retrieve user’s notifications

public_timeline(conn, options \\ [])

Retrieve statuses from the public timeline

reblog(conn, id)

Reblog a status

reblogged_by(conn, id)

Fetch the list of users who reblogged the status

reject_follow_request(conn, id)

Rejects a follow request

relationships(conn, ids)

Get the relationships of authenticated user towards given other users

report(conn, account_id, status_ids, comment)

Report a user

reports(conn)

Retrieve a user’s reports

search(conn, query, options \\ [])

Search for content

search_account(conn, options)

Search for accounts

status(conn, id)

Retrieve status

status_context(conn, id)

Retrieve status context

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

update_credentials(conn, data)

Make changes to the authenticated user

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

accept_follow_request(conn, id) 
accept_follow_request(Hunter.Client.t, non_neg_integer) :: boolean

Accepts a follow request

Parameters

  • conn - connection credentials
  • id - follow request id
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
blocks(conn) 
blocks(Hunter.Client.t) :: [Hunter.Account.t]

Retrieve user’s blocks

Parameters

  • conn - connection credentials
card_by_status(conn, id) 
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
clear_notifications(conn) 
clear_notifications(Hunter.Client.t) :: map

Deletes all notifications from the Mastodon server for the authenticated user

Parameters

  • conn - connection credentials
create_app(name, redirect_uri \\ "urn:ietf:wg:oauth:2.0:oob", scopes \\ ["read"], website \\ nil, options \\ []) 
create_app(String.t, URI.t, [String.t], String.t, Keyword.t) :: Hunter.Application.t

Register a new OAuth client app on the target instance

Parameters

  • name - name of your application
  • redirect_uri - where the user should be redirected after authorization, default: urn:ietf:wg:oauth:2.0:oob (no redirect)
  • scopes - scope list, see the scope section for more details, default: read
  • website - URL to the homepage of your app, default: nil
  • options - option list

Scopes

  • read - read data
  • write - post statuses and upload media for statuses
  • follow - follow, unfollow, block, unblock

Multiple scopes can be requested during the authorization phase with the scope query param

Options

  • save? - persists your application information to a file, so, you can use them later. default: false
  • api_base_url - specifies if you want to register an application on a different instance. default: https://mastodon.social
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
favourited_by(conn, id) 
favourited_by(Hunter.Client.t, non_neg_integer) :: [Hunter.Account.t]

Fetch the list of users who favourited the 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
follow_requests(conn) 
follow_requests(Hunter.Client.t) :: [Hunter.Account.t]

Retrieve a list of follow requests

Parameters

  • conn - connection credentials
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 \\ []) 
hashtag_timeline(Hunter.Client.t, [String.t], Keyword.t) :: [Hunter.Status.t]

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]
instance_info(conn) 
instance_info(Hunter.Client.t) :: Hunter.Instance.t

Retrieve instance information

Parameters

  • conn - connection credentials
load_credentials(name) 
load_credentials(String.t) :: Hunter.Application.t

Load persisted application’s credentials

Parameters

  • name - application’s name
log_in(app, username, password, base_url \\ "https://mastodon.social")

Retrieve access token

Parameters

  • app - application details, see: Hunter.Application.create_app/5 for more details.
  • username - account’s email
  • password - account’s password
  • base_url - API base url, default: https://mastodon.social
mute(conn, id) 
mute(Hunter.Client.t, non_neg_integer) :: Hunter.Relationship.t

Mute a user

Parameters

  • conn - connection credentials
  • id - user identifier
mutes(conn) 
mutes(Hunter.Client.t) :: [Hunter.Account.t]

Retrieve user’s mutes

Parameters

  • conn - connection credentials
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
notification(conn, id) 
notification(Hunter.Client.t, non_neg_integer) :: Hunter.Notification.t

Retrieve single notification

Parameters

  • conn - connection credentials
  • id - notification identifier
notifications(conn) 
notifications(Hunter.Client.t) :: [Hunter.Notification.t]

Retrieve user’s notifications

Parameters

  • conn - connection credentials
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
reblogged_by(conn, id) 
reblogged_by(Hunter.Client.t, non_neg_integer) :: [Hunter.Account.t]

Fetch the list of users who reblogged the status.

Parameters

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

Rejects a follow request

Parameters

  • conn - connection credentials
  • id - follow request id
relationships(conn, ids) 
relationships(Hunter.Client.t, [non_neg_integer]) :: [Hunter.Relationship.t]

Get the relationships of authenticated user towards given other users

Parameters

  • conn - connection credentials
  • id - list of relationship IDs
report(conn, account_id, status_ids, comment) 
report(Hunter.Client.t, non_neg_integer, [non_neg_integer], String.t) :: Hunter.Report.t

Report a user

Parameters

  • conn - connection credentials
  • account_id - the ID of the account to report
  • status_ids - the IDs of statuses to report
  • comment - a comment to associate with the report
reports(conn) 
reports(Hunter.Client.t) :: [Hunter.Report.t]

Retrieve a user’s reports

Parameters

  • conn - connection credentials
search(conn, query, options \\ []) 
search(Hunter.Client.t, String.t, Keyword.t) :: Hunter.Result.t

Search for content

Parameters

  • conn - connection credentials
  • q - the search query
  • options - option list

Options

  • resolve - whether to resolve non-local accounts
search_account(conn, options) 
search_account(Hunter.Client.t, Keyword.t) :: [Hunter.Account.t]

Search for accounts

Parameters

  • conn - connection credentials
  • options - option list

Options

  • q: what to search for
  • limit: maximum number of matching accounts to return, default: 40
status(conn, id) 
status(Hunter.Client.t, non_neg_integer) :: Hunter.Status.t

Retrieve status

Parameters

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

Retrieve status context

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
update_credentials(conn, data) 
update_credentials(Hunter.Client.t, map) :: Hunter.Account.t

Make changes to the authenticated user

Parameters

  • conn - connection credentials
  • data - data payload

Possible keys for payload

  • display_name - name to display in the user’s profile
  • note - new biography for the user
  • avatar - base64 encoded image to display as the user’s avatar (e.g. data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAADrCAYAAAA...)
  • header - base64 encoded image to display as the user’s header image (e.g. data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAADrCAYAAAA...)
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