extwitter v0.11.0 ExTwitter.Behaviour behaviour

A definition of the intended behavior of the core functions.

Link to this section Summary

Callbacks

Link to this section Types

Link to this type

stream_control_type()

stream_control_type() :: :stop

Link to this section Callbacks

Link to this callback

access_token(arg1, arg2)

access_token(String.t(), String.t()) :: {:ok, String.t()} | {:error, String.t()}
Link to this callback

authenticate_url(arg1)

authenticate_url(String.t()) :: {:ok, String.t()} | {:error, String.t()}
Link to this callback

authenticate_url(arg1, map)

authenticate_url(String.t(), map()) :: {:ok, String.t()} | {:error, String.t()}
Link to this callback

authorize_url(arg1)

authorize_url(String.t()) :: {:ok, String.t()} | {:error, String.t()}
Link to this callback

authorize_url(arg1, map)

authorize_url(String.t(), map()) :: {:ok, String.t()} | {:error, String.t()}
Link to this callback

configure()

configure() :: Keyword.t() | nil
Link to this callback

configure(arg1)

configure(Keyword.t()) :: :ok
Link to this callback

configure(arg1, arg2)

configure(:global | :process, Keyword.t()) :: :ok
Link to this callback

create_favorite(integer, arg2)

create_favorite(integer(), Keyword.t()) :: ExTwitter.Model.Tweet.t()
Link to this callback

destroy_direct_message(integer)

destroy_direct_message(integer()) :: ExTwitter.Model.DirectMessage.t()
Link to this callback

destroy_direct_message(integer, arg2)

destroy_direct_message(integer(), Keyword.t()) ::
  ExTwitter.Model.DirectMessage.t()
Link to this callback

destroy_favorite(integer, arg2)

destroy_favorite(integer(), Keyword.t()) :: ExTwitter.Model.Tweet.t()
Link to this callback

destroy_status(integer)

destroy_status(integer()) :: ExTwitter.Model.Tweet.t()
Link to this callback

destroy_status(integer, arg2)

destroy_status(integer(), Keyword.t()) :: ExTwitter.Model.Tweet.t()
Link to this callback

direct_message(arg1)

direct_message(integer() | String.t()) :: ExTwitter.Model.DirectMessage.t()
Link to this callback

direct_messages()

direct_messages() :: [ExTwitter.Model.DirectMessage.t()]
Link to this callback

direct_messages(arg1)

direct_messages(Keyword.t()) :: [ExTwitter.Model.DirectMessage.t()]
Link to this callback

favorites()

favorites() :: [ExTwitter.Model.Tweet.t()]
Link to this callback

favorites(arg1)

favorites(Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

follower_ids(arg1)

follower_ids(String.t() | integer() | Keyword.t()) :: ExTwitter.Model.Cursor.t()
Link to this callback

follower_ids(arg1, arg2)

follower_ids(String.t() | integer(), Keyword.t()) :: ExTwitter.Model.Cursor.t()
Link to this callback

followers(arg1, arg2)

Link to this callback

friend_ids(arg1)

friend_ids(String.t() | integer() | Keyword.t()) :: ExTwitter.Model.Cursor.t()
Link to this callback

friend_ids(arg1, arg2)

Link to this callback

geo_search(arg1)

geo_search(String.t()) :: [ExTwitter.Model.Place.t()]
Link to this callback

geo_search(arg1, arg2)

geo_search(String.t(), Keyword.t()) :: [ExTwitter.Model.Place.t()]
Link to this callback

home_timeline()

home_timeline() :: [ExTwitter.Model.Tweet.t()]
Link to this callback

home_timeline(arg1)

home_timeline(Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

list_members(arg1)

list_members(Keyword.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

list_members(arg1, arg2)

list_members(String.t(), String.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

list_members(arg1, arg2, arg3)

list_members(String.t(), String.t(), Keyword.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

list_memberships()

list_memberships() :: [ExTwitter.Model.List.t()]
Link to this callback

list_memberships(arg1)

list_memberships(Keyword.t()) :: [ExTwitter.Model.List.t()]
Link to this callback

list_subscribers(arg1)

list_subscribers(Keyword.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

list_subscribers(arg1, arg2)

list_subscribers(String.t(), String.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

list_subscribers(arg1, arg2, arg3)

list_subscribers(String.t(), String.t(), Keyword.t()) :: [
  ExTwitter.Model.User.t()
]
Link to this callback

list_timeline(arg1)

list_timeline(Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

list_timeline(arg1, arg2)

list_timeline(String.t(), String.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

list_timeline(arg1, arg2, arg3)

list_timeline(String.t(), String.t(), Keyword.t()) :: [
  ExTwitter.Model.Tweet.t()
]
Link to this callback

lookup_status(arg1)

lookup_status(String.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

lookup_status(arg1, arg2)

lookup_status(String.t(), Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

mentions_timeline()

mentions_timeline() :: [ExTwitter.Model.Tweet.t()]
Link to this callback

mentions_timeline(arg1)

mentions_timeline(Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

new_direct_message(arg1, arg2)

new_direct_message(String.t() | integer(), String.t()) ::
  ExTwitter.Model.DirectMessage.t()
Link to this callback

rate_limit_status()

rate_limit_status() :: map()
Link to this callback

rate_limit_status(arg1)

rate_limit_status(Keyword.t()) :: map()
Link to this callback

request(arg1, arg2)

request(:get | :post, String.t()) :: map()
Link to this callback

request(arg1, arg2, arg3)

request(:get | :post, String.t(), Keyword.t()) :: map()
Link to this callback

request_token()

request_token() :: [ExTwitter.Model.RequestToken.t()]
Link to this callback

request_token(arg1)

request_token(String.t()) :: [ExTwitter.Model.RequestToken.t()]
Link to this callback

retweet(integer, arg2)

Link to this callback

retweeter_ids(arg1)

retweeter_ids(integer() | String.t()) :: [integer() | String.t()]
Link to this callback

retweeter_ids(arg1, arg2)

retweeter_ids(integer() | String.t(), Keyword.t()) :: [integer() | String.t()]
Link to this callback

retweets(arg1)

retweets(integer() | String.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

retweets(arg1, arg2)

Link to this callback

retweets_of_me()

retweets_of_me() :: [ExTwitter.Model.Tweet.t()]
Link to this callback

retweets_of_me(arg1)

retweets_of_me(Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

reverse_geocode(float, float)

reverse_geocode(float(), float()) :: [ExTwitter.Model.Place.t()]
Link to this callback

reverse_geocode(float, float, arg3)

reverse_geocode(float(), float(), Keyword.t()) :: [ExTwitter.Model.Place.t()]
Link to this callback

search_next_page(arg1)

search_next_page(String.t()) :: [map()]
Link to this callback

sent_direct_messages()

sent_direct_messages() :: [ExTwitter.Model.DirectMessage.t()]
Link to this callback

sent_direct_messages(arg1)

sent_direct_messages(Keyword.t()) :: [ExTwitter.Model.DirectMessage.t()]
Link to this callback

stream_control(pid, stream_control_type)

stream_control(pid(), stream_control_type()) :: :ok
Link to this callback

stream_control(pid, stream_control_type, list)

stream_control(pid(), stream_control_type(), [{:timeout, integer()}]) :: :ok
Link to this callback

stream_filter(arg1)

stream_filter(Keyword.t()) :: Enumerable.t()
Link to this callback

stream_filter(arg1, timeout)

stream_filter(Keyword.t(), timeout()) :: Enumerable.t()
Link to this callback

stream_sample()

stream_sample() :: Enumerable.t()
Link to this callback

stream_sample(arg1)

stream_sample(Keyword.t()) :: Enumerable.t()
Link to this callback

stream_user()

stream_user() :: Enumerable.t()
Link to this callback

stream_user(arg1)

stream_user(Keyword.t()) :: Enumerable.t()
Link to this callback

stream_user(arg1, integer)

stream_user(Keyword.t(), integer()) :: Enumerable.t()
Link to this callback

trends(arg1, arg2)

Link to this callback

unretweet(integer)

unretweet(integer()) :: ExTwitter.Model.Tweet.t()
Link to this callback

unretweet(integer, arg2)

Link to this callback

update_with_chunked_media(arg1, arg2, arg3)

update_with_chunked_media(String.t(), String.t(), String.t()) ::
  ExTwitter.Model.Tweet.t()
Link to this callback

update_with_chunked_media(arg1, arg2, arg3, arg4)

update_with_chunked_media(String.t(), String.t(), String.t(), Keyword.t()) ::
  ExTwitter.Model.Tweet.t()
Link to this callback

update_with_media(arg1, arg2)

update_with_media(String.t(), Keyword.t()) :: ExTwitter.Model.Tweet.t()
Link to this callback

update_with_media(arg1, arg2, arg3)

update_with_media(String.t(), String.t(), Keyword.t()) ::
  ExTwitter.Model.Tweet.t()
Link to this callback

upload_media(arg1, arg2)

upload_media(String.t(), String.t()) :: integer()
Link to this callback

upload_media(arg1, arg2, integer)

upload_media(String.t(), String.t(), integer()) :: integer()
Link to this callback

user_lookup(arg1)

user_lookup(String.t() | integer() | Keyword.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

user_lookup(arg1, arg2)

user_lookup([String.t() | integer()] | String.t() | integer(), Keyword.t()) :: [
  ExTwitter.Model.User.t()
]
Link to this callback

user_profile_banner(arg1)

user_profile_banner(String.t() | integer()) :: ExTwitter.Model.ProfileBanner.t()
Link to this callback

user_search(arg1)

user_search(String.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

user_search(arg1, arg2)

user_search(String.t(), Keyword.t()) :: [ExTwitter.Model.User.t()]
Link to this callback

user_timeline()

user_timeline() :: [ExTwitter.Model.Tweet.t()]
Link to this callback

user_timeline(arg1)

user_timeline(Keyword.t()) :: [ExTwitter.Model.Tweet.t()]
Link to this callback

verify_credentials()

verify_credentials() :: ExTwitter.Model.User.t()
Link to this callback

verify_credentials(arg1)

verify_credentials(Keyword.t()) :: ExTwitter.Model.User.t()