Twittex v0.2.2 Twittex.Client
Twitter client to work with the Twitter API.
The client is started as part of the application and authenticates using the defined configuration.
Basically, this means that once started, your application can use function from this module directly without having to handle supervision or authentication work:
Twitter.Client.search! "#myelixirstatus"
Read the Twittex.API
documentation for more details on how authentication is implemented.
Summary
Functions
Returns a collection of the most recent Tweets and retweets posted by the authenticated 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 authenticated 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 as part of a supervision tree
Returns a stream of relevant Tweets matching the given query
Same as stream/2
but raises HTTPoison.Error
if an error occurs during the
request
Returns a stream of tweets authored by the authenticating user
Same as user_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
Returns a collection of the most recent Tweets and retweets posted by the authenticated user and the users they follow.
Same as home_timeline/1
but raises HTTPoison.Error
if an error occurs during the
request.
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.
Same as mentions_timeline/1
but raises HTTPoison.Error
if an error occurs during the
request.
Returns the most recent tweets authored by the authenticated user that have been retweeted by others.
Same as retweets_of_me/1
but raises HTTPoison.Error
if an error occurs during the
request.
search(String.t, Keyword.t) :: {:ok, %{}} | {:error, HTTPoison.Error.t}
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 as part of a supervision tree.
stream(String.t | :sample, Keyword.t) :: {:ok, Enumerable.t} | {:error, HTTPoison.Error.t}
Returns a stream of relevant Tweets matching the given query
.
If query
is set to :sample
(default), this function returns a small random
sample of all public statuses (roughly 1% of all public Tweets).
Options
:stage
- Returns the stage pid instead of the stream.:min_demand
- Minimum demand for this subscription.:max_demand
- Maximum demand for this subscription.
Same as stream/2
but raises HTTPoison.Error
if an error occurs during the
request.
user_stream(Keyword.t) :: {:ok, Enumerable.t} | {:error, HTTPoison.Error.t}
user_stream(Keyword.t) :: Enumerable.t
Returns a stream of tweets authored by the authenticating user.
Options
:stage
- Returns the stage pid instead of the stream.:min_demand
- Minimum demand for this subscription.:max_demand
- Maximum demand for this subscription.
Same as user_stream/2
but raises HTTPoison.Error
if an error occurs during the
request.
user_timeline(String.t, Keyword.t) :: {:ok, %{}} | {:error, HTTPoison.Error.t}
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.