Twittex.Client
Twitter client implementation, provides helper functions to query the API.
Summary
Functions
Returns a collection of the most recent Tweets and retweets posted by the authenticating user and the users they follow
Same as home_timeline/1
but raises HTTPoison.Error
if an error occurs during the
request
Returns the 20 most recent mentions (tweets containing a users’s @screen_name
)
for the authenticating user
Same as mentions_timeline/1
but raises HTTPoison.Error
if an error occurs during the
request
Returns the most recent tweets authored by the authenticating user that have been retweeted by others
Same as retweets_of_me/1
but raises HTTPoison.Error
if an error occurs during the
request
Returns a collection of relevant Tweets matching the given query
Same as search/2
but raises HTTPoison.Error
if an error occurs during the
request
Starts the process linked to the current process
Returns a GenEvent.Stream
that consume Tweets from a Twitter streaming
endpoint
Same as stream/2
but raises HTTPoison.Error
if an error occurs during the
request
Returns a collection of the most recent Tweets posted by the user with the given
screen_name
Same as user_timeline/2
but raises HTTPoison.Error
if an error occurs during the
request
Functions
Specs
home_timeline(Keyword.t) ::
{:ok, %{}} |
{:error, HTTPoison.Error.t}
Returns a collection of the most recent Tweets and retweets posted by the authenticating user and the users they follow.
Specs
home_timeline!(Keyword.t) :: %{}
Same as home_timeline/1
but raises HTTPoison.Error
if an error occurs during the
request.
Specs
mentions_timeline(Keyword.t) ::
{:ok, %{}} |
{:error, HTTPoison.Error.t}
Returns the 20 most recent mentions (tweets containing a users’s @screen_name
)
for the authenticating user.
Specs
mentions_timeline!(Keyword.t) :: %{}
Same as mentions_timeline/1
but raises HTTPoison.Error
if an error occurs during the
request.
Specs
retweets_of_me(Keyword.t) ::
{:ok, %{}} |
{:error, HTTPoison.Error.t}
Returns the most recent tweets authored by the authenticating user that have been retweeted by others.
Specs
retweets_of_me!(Keyword.t) :: %{}
Same as retweets_of_me/1
but raises HTTPoison.Error
if an error occurs during the
request.
Returns a collection of relevant Tweets matching the given query
.
Same as search/2
but raises HTTPoison.Error
if an error occurs during the
request.
Specs
start_link(Keyword.t) :: GenServer.on_start
Starts the process linked to the current process.
Specs
stream(String.t, Keyword.t) ::
{:ok, GenEvent.Stream.t} |
{:error, HTTPoison.Error.t}
Returns a GenEvent.Stream
that consume Tweets from a Twitter streaming
endpoint.
Specs
stream!(String.t, Keyword.t) :: GenEvent.Stream.t
Same as stream/2
but raises HTTPoison.Error
if an error occurs during the
request.
Returns a collection of the most recent Tweets posted by the user with the given
screen_name
.
Same as user_timeline/2
but raises HTTPoison.Error
if an error occurs during the
request.