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
Create new status
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
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(Hunter.Client.t, String.t, non_neg_integer, [non_neg_integer]) :: Hunter.Status.t
Create new status
Parameters
conn
- connection credentialstext
- [String]in_reply_to_id
- [Integer]media_ids
- [Array]
Follow a remote user
Parameters
conn
- connection credentialsuri
- URI of the remote user, in the format ofusername@domain
Retrieve statuses from a hashtag
Parameters
conn
- connection credentialshashtag
- string list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Retrieve statuses from the home timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Initializes a client
Options
base_url
- URL of the instance you want to connect tobearer_token
- [String] OAuth access token for your authenticated user
public_timeline(Hunter.Client.t, Keyword.t) :: [Hunter.Status.t]
Retrieve statuses from the public timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Get the relationships of authenticated user towards given other users
Parameters
id
- list of relationship IDs
Search for content
Parameters
q
- search query
Options
resolve
- whether to resolve non-local accounts
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 identifieroptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Unblock a user
conn
- connection credentialsid
- user identifier
User agent of the client
Returns Hunter version