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
Create new status
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
Report a user
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
Retrieve account
Parameters
conn
- connection credentialsid
- account identifier
Callback implementation for Hunter.Api.account/2
.
Block a user
Parameters
conn
- connection credentialsid
- user identifier
Callback implementation for Hunter.Api.block/2
.
Retrieve user’s blocks
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.blocks/1
.
Retrieve a card associated with a status
Parameters
conn
- connection credentialsid
- status id
Callback implementation for Hunter.Api.card_by_status/2
.
Deletes all notifications from the Mastodon server for the authenticated user
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.clear_notifications/1
.
Register a new OAuth client app on the target instance
Parameters
conn
- connection credentialsname
- name of your applicationredirect_uri
- where the user should be redirected after authorization, for no redirect, useurn:ietf:wg:oauth:2.0:oob
scopes
- scope list, see the scope section for more detailswebsite
- URL to the homepage of your app
Scopes
read
- read datawrite
- post statuses and upload media for statusesfollow
- 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 new status
Parameters
conn
- connection credentialstext
- [String]in_reply_to_id
- [Integer]media_ids
- [Array]
Callback implementation for Hunter.Api.create_status/4
.
Destroy status
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.destroy_status/2
.
Favorite a status
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.favourite/2
.
Fetch a user’s favourites
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.favourites/1
.
Follow a user
Parameters
conn
- connection credentialsid
- user id
Callback implementation for Hunter.Api.follow/2
.
Follow a remote user
Parameters
conn
- connection credentialsuri
- URI of the remote user, in the format ofusername@domain
Callback implementation for Hunter.Api.follow_by_uri/2
.
Retrieve a list of follow requests
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.follow_requests/1
.
Get a list of followers
Parameters
conn
- connection credentialsid
- account identifier
Callback implementation for Hunter.Api.followers/2
.
Get a list of followed accounts
Parameters
conn
- connection credentialsid
- account identifier
Callback implementation for Hunter.Api.following/2
.
Retrieve statuses from a hashtag
Parameters
conn
- connection credentialshashtag
- list of strings
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Callback implementation for Hunter.Api.hashtag_timeline/3
.
Retrieve statuses from the home timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Callback implementation for Hunter.Api.home_timeline/2
.
Retrieve instance information
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.instance_info/1
.
Mute a user
Parameters
conn
- connection credentialsid
- user identifier
Callback implementation for Hunter.Api.mute/2
.
Retrieve user’s mutes
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.mutes/1
.
Retrieve single notification
Parameters
conn
- connection credentialsid
- notification identifier
Callback implementation for Hunter.Api.notification/2
.
Retrieve user’s notifications
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.notifications/1
.
Retrieve statuses from the public timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Callback implementation for Hunter.Api.public_timeline/2
.
Reblog a status
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.reblog/2
.
Get the relationships of authenticated user towards given other users
Parameters
conn
- connection credentialsid
- list of relationship IDs
Callback implementation for Hunter.Api.relationships/2
.
Report a user
Parameters
conn
- connection credentialsaccount_id
- the ID of the account to reportstatus_ids
- the IDs of statuses to reportcomment
- a comment to associate with the report
Callback implementation for Hunter.Api.report/4
.
Retrieve a user’s reports
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.reports/1
.
Search for content
Parameters
conn
- connection credentialsq
- the search queryoptions
- option list
Options
resolve
- whether to resolve non-local accounts
Callback implementation for Hunter.Api.search/3
.
Search for accounts
Parameters
conn
- connection credentialsoptions
- option list
Options
q
: what to search forlimit
: maximum number of matching accounts to return, default: 40
Callback implementation for Hunter.Api.search_account/2
.
Retrieve status
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.status/2
.
Retrieve status context
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.status_context/2
.
Get an account’s statuses
Options
only_media
- (optional): only return statuses that have media attachmentsexclude_replies
- (optional): skip statuses that reply to other statuses
Unblock a user
conn
- connection credentialsid
- user identifier
Callback implementation for Hunter.Api.unblock/2
.
Undo a favorite of a status
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.unfavourite/2
.
Unfollow a user
Parameters
conn
- connection credentialsid
- user identifier
Callback implementation for Hunter.Api.unfollow/2
.
Unmute a user
Parameters
conn
- connection credentialsid
- user identifier
Callback implementation for Hunter.Api.unmute/2
.
Undo a reblog of a status
Parameters
conn
- connection credentialsid
- status identifier
Callback implementation for Hunter.Api.unreblog/2
.
Upload a media file
Parameters
conn
- connection credentialsfile
- media to be uploaded
Callback implementation for Hunter.Api.upload_media/2
.
Retrieve account of authenticated user
Parameters
conn
- connection credentials
Callback implementation for Hunter.Api.verify_credentials/1
.