hunter v0.1.0 Hunter.Api behaviour
Summary
Callbacks
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
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
Retrieve account of authenticated user
Callbacks
create_app(conn :: Hunter.Client.t, name :: String.t, redirect_uri :: URI.t, scopes :: String.t, website :: String.t) :: Hunter.Application.t
Register a new OAuth client app on the target instance
Parameters
conn
- connection credentialsname
redirect_uri
scopes
website
create_status(conn :: Hunter.Client.t, text :: String.t, in_reply_to_id :: non_neg_integer, media_ids :: [non_neg_integer]) :: Hunter.Status.t
Create new status
Parameters
conn
- connection credentialstext
- [String]in_reply_to_id
- [Integer]media_ids
- [Array]
follow_by_uri(conn :: Hunter.Client.t, id :: non_neg_integer) :: Hunter.Account.t
Follow a remote user
Parameters
conn
- connection credentialsuri
- URI of the remote user, in the format ofusername@domain
hashtag_timeline(conn :: Hunter.Client.t, hashtag :: [String.t], options :: Keyword.t) :: [Hunter.Status]
Retrieve statuses from a hashtag
Parameters
conn
- connection credentialshashtag
- list of strings
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
home_timeline(conn :: Hunter.Client.t, options :: Keyword.t) :: [Hunter.Status.t]
Retrieve statuses from the home timeline
Parameters
conn
- connection credentialsoptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
public_timeline(conn :: Hunter.Client.t, options :: 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(Hunter.Client.t, query :: String.t, options :: Keyword.t) :: Hunter.Result.t
Search for content
Parameters
conn
- connection credentialsq
- the search queryoptions
- option list
Options
resolve
- whether to resolve non-local accounts
statuses(conn :: Hunter.Client.t, account_id :: non_neg_integer, options :: Keyword.t) :: [Hunter.Status.t]
Get a list of statuses by a user
Parameters
conn
- connection credentialsaccount_id
- account identifieroptions
- option list
Options
max_id
- [Integer]since_id
- [Integer]limit
- [Integer]
Unblock a user
conn
- connection credentialsid
- user identifier
unfavourite(conn :: Hunter.Client.t, id :: non_neg_integer) :: Hunter.Status.t
Undo a favorite of a status
Parameters
conn
- connection credentialsid
- status identifier
unfollow(conn :: Hunter.Client.t, id :: non_neg_integer) :: Hunter.Relationship.t
Unfollow a user
Parameters
conn
- connection credentialsid
- user identifier