hunter v0.3.0 Hunter.Api.HTTPClient

HTTP Client for Hunter

Summary

Functions

Retrieve account

Block a user

Retrieve user’s blocks

Retrieve a card associated with a status

Deletes all notifications from the Mastodon server for the authenticated user

Register a new OAuth client app on the target instance

Destroy status

Favorite a status

Fetch a user’s favourites

Follow a user

Follow a remote user

Retrieve a list of follow requests

Get a list of followers

Get a list of followed accounts

Retrieve statuses from a hashtag

Retrieve statuses from the home timeline

Retrieve instance information

Mute a user

Retrieve user’s mutes

Retrieve single notification

Retrieve user’s notifications

Retrieve statuses from the public timeline

Reblog a status

Get the relationships of authenticated user towards given other users

Retrieve a user’s reports

Search for content

Search for accounts

Retrieve status

Retrieve status context

Get an account’s statuses

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

Retrieve account of authenticated user

Functions

account(conn, id)

Retrieve account

Parameters

  • conn - connection credentials
  • id - account identifier

Callback implementation for Hunter.Api.account/2.

block(conn, id)

Block a user

Parameters

  • conn - connection credentials
  • id - user identifier

Callback implementation for Hunter.Api.block/2.

blocks(conn)

Retrieve user’s blocks

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.blocks/1.

card_by_status(conn, id)

Retrieve a card associated with a status

Parameters

  • conn - connection credentials
  • id - status id

Callback implementation for Hunter.Api.card_by_status/2.

clear_notifications(conn)

Deletes all notifications from the Mastodon server for the authenticated user

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.clear_notifications/1.

create_app(conn, name, redirect_uri, scopes, website)

Register a new OAuth client app on the target instance

Parameters

  • conn - connection credentials
  • name - name of your application
  • redirect_uri - where the user should be redirected after authorization, for no redirect, use urn:ietf:wg:oauth:2.0:oob
  • scopes - scope list, see the scope section for more details
  • website - URL to the homepage of your app

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

Callback implementation for Hunter.Api.create_app/5.

create_status(conn, text, in_reply_to_id, media_ids)

Create new status

Parameters

  • conn - connection credentials
  • text - [String]
  • in_reply_to_id - [Integer]
  • media_ids - [Array]

Callback implementation for Hunter.Api.create_status/4.

destroy_status(conn, id)

Destroy status

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.destroy_status/2.

favourite(conn, id)

Favorite a status

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.favourite/2.

favourites(conn)

Fetch a user’s favourites

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.favourites/1.

follow(conn, id)

Follow a user

Parameters

  • conn - connection credentials
  • id - user id

Callback implementation for Hunter.Api.follow/2.

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

Callback implementation for Hunter.Api.follow_by_uri/2.

follow_requests(conn)

Retrieve a list of follow requests

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.follow_requests/1.

followers(conn, id)

Get a list of followers

Parameters

  • conn - connection credentials
  • id - account identifier

Callback implementation for Hunter.Api.followers/2.

following(conn, id)

Get a list of followed accounts

Parameters

  • conn - connection credentials
  • id - account identifier

Callback implementation for Hunter.Api.following/2.

hashtag_timeline(conn, hashtag, options)

Retrieve statuses from a hashtag

Parameters

  • conn - connection credentials
  • hashtag - list of strings

Options

  • max_id - [Integer]
  • since_id - [Integer]
  • limit - [Integer]

Callback implementation for Hunter.Api.hashtag_timeline/3.

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]

Callback implementation for Hunter.Api.home_timeline/2.

instance_info(conn)

Retrieve instance information

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.instance_info/1.

mute(conn, id)

Mute a user

Parameters

  • conn - connection credentials
  • id - user identifier

Callback implementation for Hunter.Api.mute/2.

mutes(conn)

Retrieve user’s mutes

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.mutes/1.

notification(conn, id)

Retrieve single notification

Parameters

  • conn - connection credentials
  • id - notification identifier

Callback implementation for Hunter.Api.notification/2.

notifications(conn)

Retrieve user’s notifications

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.notifications/1.

public_timeline(conn, options)

Retrieve statuses from the public timeline

Parameters

  • conn - connection credentials
  • options - option list

Options

  • max_id - [Integer]
  • since_id - [Integer]
  • limit - [Integer]

Callback implementation for Hunter.Api.public_timeline/2.

reblog(conn, id)

Reblog a status

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.reblog/2.

relationships(conn, ids)

Get the relationships of authenticated user towards given other users

Parameters

  • conn - connection credentials
  • id - list of relationship IDs

Callback implementation for Hunter.Api.relationships/2.

report(conn, account_id, status_ids, comment)

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

Callback implementation for Hunter.Api.report/4.

reports(conn)

Retrieve a user’s reports

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.reports/1.

search(conn, query, options)

Search for content

Parameters

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

Options

  • resolve - whether to resolve non-local accounts

Callback implementation for Hunter.Api.search/3.

search_account(conn, options)

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

Callback implementation for Hunter.Api.search_account/2.

status(conn, id)

Retrieve status

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.status/2.

status_context(conn, id)

Retrieve status context

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.status_context/2.

statuses(conn, account_id, options)

Get an account’s statuses

Options

  • only_media - (optional): only return statuses that have media attachments
  • exclude_replies - (optional): skip statuses that reply to other statuses
unblock(conn, id)

Unblock a user

  • conn - connection credentials
  • id - user identifier

Callback implementation for Hunter.Api.unblock/2.

unfavourite(conn, id)

Undo a favorite of a status

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.unfavourite/2.

unfollow(conn, id)

Unfollow a user

Parameters

  • conn - connection credentials
  • id - user identifier

Callback implementation for Hunter.Api.unfollow/2.

unmute(conn, id)

Unmute a user

Parameters

  • conn - connection credentials
  • id - user identifier

Callback implementation for Hunter.Api.unmute/2.

unreblog(conn, id)

Undo a reblog of a status

Parameters

  • conn - connection credentials
  • id - status identifier

Callback implementation for Hunter.Api.unreblog/2.

upload_media(conn, file)

Upload a media file

Parameters

  • conn - connection credentials
  • file - media to be uploaded

Callback implementation for Hunter.Api.upload_media/2.

verify_credentials(conn)

Retrieve account of authenticated user

Parameters

  • conn - connection credentials

Callback implementation for Hunter.Api.verify_credentials/1.