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

home_timeline(options \\ [])
home_timeline(Keyword.t) ::
  {:ok, %{}} |
  {:error, HTTPoison.Error.t}

Returns a collection of the most recent Tweets and retweets posted by the authenticated user and the users they follow.

home_timeline!(options \\ [])
home_timeline!(Keyword.t) :: %{}

Same as home_timeline/1 but raises HTTPoison.Error if an error occurs during the request.

mentions_timeline(options \\ [])
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.

mentions_timeline!(options \\ [])
mentions_timeline!(Keyword.t) :: %{}

Same as mentions_timeline/1 but raises HTTPoison.Error if an error occurs during the request.

retweets_of_me(options \\ [])
retweets_of_me(Keyword.t) ::
  {:ok, %{}} |
  {:error, HTTPoison.Error.t}

Returns the most recent tweets authored by the authenticated user that have been retweeted by others.

retweets_of_me!(options \\ [])
retweets_of_me!(Keyword.t) :: %{}

Same as retweets_of_me/1 but raises HTTPoison.Error if an error occurs during the request.

search(query, options \\ [])
search(String.t, Keyword.t) ::
  {:ok, %{}} |
  {:error, HTTPoison.Error.t}

Returns a collection of relevant Tweets matching the given query.

search!(query, options \\ [])
search!(String.t, Keyword.t) :: %{}

Same as search/2 but raises HTTPoison.Error if an error occurs during the request.

start_link(options \\ [])
start_link(Keyword.t) :: GenServer.on_start

Starts the process as part of a supervision tree.

stream(query \\ :sample, options \\ [])
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.
stream!(query \\ :sample, options \\ [])
stream!(String.t | :sample, Keyword.t) :: Enumerable.t

Same as stream/2 but raises HTTPoison.Error if an error occurs during the request.

user_stream(options \\ [])
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.
user_stream!(options \\ [])

Same as user_stream/2 but raises HTTPoison.Error if an error occurs during the request.

user_timeline(screen_name, options \\ [])
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.

user_timeline!(screen_name, options \\ [])
user_timeline!(String.t, Keyword.t) :: %{}

Same as user_timeline/2 but raises HTTPoison.Error if an error occurs during the request.