extwitter

ExTwitter.Behaviour behaviour (extwitter v0.14.0) View Source

A definition of the intended behavior of the core functions.

Link to this section Summary

Types

stream_control_type()

Callbacks

access_token(t, t)
add_list_members(integer, list)
authenticate_url(t)
authenticate_url(t, map)
authorize_url(t)
authorize_url(t, map)
block(arg1)
configure()
configure(t)
configure(arg1, t)
create_favorite(integer, t)
create_list(t)
destroy_direct_message(integer)
destroy_direct_message(integer, t)
destroy_favorite(integer, t)
destroy_list(t)
destroy_status(integer)
destroy_status(integer, t)
direct_message(arg1)
direct_messages()
direct_messages(t)
favorites()
favorites(t)
follow(arg1)
follow(arg1, t)
follower_ids(arg1)
follower_ids(arg1, t)
followers(arg1)
followers(arg1, t)
friend_ids(arg1)
friend_ids(arg1, t)
friends(arg1)
friends(arg1, t)
geo_search(t)
geo_search(t, t)
home_timeline()
home_timeline(t)
list_members(t)
list_members(t, t)
list_members(t, t, t)
list_memberships()
list_memberships(t)
list_subscribers(t)
list_subscribers(t, t)
list_subscribers(t, t, t)
list_timeline(t)
list_timeline(t, t)
list_timeline(t, t, t)
lists(arg1)
lists(arg1, t)
lookup_status(t)
lookup_status(t, t)
mentions_timeline()
mentions_timeline(t)
new_direct_message(arg1, t)
rate_limit_status()
rate_limit_status(t)
request(arg1, t)
request(arg1, t, t)
request_token()
request_token(t)
retweet(integer)
retweet(integer, t)
retweeter_ids(arg1)
retweeter_ids(arg1, t)
retweets(arg1)
retweets(arg1, t)
retweets_of_me()
retweets_of_me(t)
reverse_geocode(float, float)
reverse_geocode(float, float, t)
search(t)
search(t, t)
search_next_page(t)
sent_direct_messages()
sent_direct_messages(t)
show(arg1)
show(arg1, t)
stream_control(pid, stream_control_type)
stream_control(pid, stream_control_type, list)
stream_filter(t)
stream_filter(t, timeout)
stream_sample()
stream_sample(t)
stream_user()
stream_user(t)
stream_user(t, integer)
trends(arg1)
trends(arg1, t)
unblock(arg1)
unfollow(arg1)
unretweet(integer)
unretweet(integer, t)
update(t)
update(t, t)
update_with_chunked_media(t, t, t)
update_with_chunked_media(t, t, t, t)
update_with_media(t, t)
update_with_media(t, t, t)
upload_media(t, t)
upload_media(t, t, integer)
user(arg1)
user(arg1, t)
user_lookup(arg1)
user_lookup(arg1, t)
user_profile_banner(arg1)
user_search(t)
user_search(t, t)
user_timeline()
user_timeline(t)
verify_credentials()
verify_credentials(t)

Link to this section Types

Link to this type

stream_control_type()

View Source

Specs

stream_control_type() :: :stop

Link to this section Callbacks

Link to this callback

access_token(t, t)

View Source

Specs

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

add_list_members(integer, list)

View Source

Specs

add_list_members(integer(), list()) :: [ExTwitter.Model.List.t()]
Link to this callback

authenticate_url(t)

View Source

Specs

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

authenticate_url(t, map)

View Source

Specs

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

authorize_url(t)

View Source

Specs

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

authorize_url(t, map)

View Source

Specs

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

block(arg1)

View Source

Specs

block(String.t() | integer()) :: ExTwitter.Model.User.t()
Link to this callback

configure()

View Source

Specs

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

configure(t)

View Source

Specs

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

configure(arg1, t)

View Source

Specs

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

create_favorite(integer, t)

View Source

Specs

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

create_list(t)

View Source

Specs

create_list(Keyword.t()) :: ExTwitter.Model.List.t()
Link to this callback

destroy_direct_message(integer)

View Source

Specs

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

destroy_direct_message(integer, t)

View Source

Specs

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

destroy_favorite(integer, t)

View Source

Specs

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

destroy_list(t)

View Source

Specs

destroy_list(Keyword.t()) :: ExTwitter.Model.List.t()
Link to this callback

destroy_status(integer)

View Source

Specs

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

destroy_status(integer, t)

View Source

Specs

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

direct_message(arg1)

View Source

Specs

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

direct_messages()

View Source

Specs

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

direct_messages(t)

View Source

Specs

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

favorites()

View Source

Specs

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

favorites(t)

View Source

Specs

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

follow(arg1)

View Source

Specs

follow(String.t() | integer()) :: ExTwitter.Model.User.t()
Link to this callback

follow(arg1, t)

View Source

Specs

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

follower_ids(arg1)

View Source

Specs

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

follower_ids(arg1, t)

View Source

Specs

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

followers(arg1)

View Source

Specs

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

followers(arg1, t)

View Source

Specs

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

friend_ids(arg1)

View Source

Specs

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

friend_ids(arg1, t)

View Source

Specs

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

friends(arg1)

View Source

Specs

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

friends(arg1, t)

View Source

Specs

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

geo_search(t)

View Source

Specs

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

geo_search(t, t)

View Source

Specs

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

home_timeline()

View Source

Specs

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

home_timeline(t)

View Source

Specs

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

list_members(t)

View Source

Specs

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

list_members(t, t)

View Source

Specs

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

list_members(t, t, t)

View Source

Specs

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

list_memberships()

View Source

Specs

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

list_memberships(t)

View Source

Specs

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

list_subscribers(t)

View Source

Specs

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

list_subscribers(t, t)

View Source

Specs

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

list_subscribers(t, t, t)

View Source

Specs

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

list_timeline(t)

View Source

Specs

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

list_timeline(t, t)

View Source

Specs

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

list_timeline(t, t, t)

View Source

Specs

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

lists(arg1)

View Source

Specs

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

lists(arg1, t)

View Source

Specs

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

lookup_status(t)

View Source

Specs

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

lookup_status(t, t)

View Source

Specs

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

mentions_timeline()

View Source

Specs

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

mentions_timeline(t)

View Source

Specs

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

new_direct_message(arg1, t)

View Source

Specs

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

rate_limit_status()

View Source

Specs

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

rate_limit_status(t)

View Source

Specs

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

request(arg1, t)

View Source

Specs

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

request(arg1, t, t)

View Source

Specs

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

request_token()

View Source

Specs

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

request_token(t)

View Source

Specs

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

retweet(integer)

View Source

Specs

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

retweet(integer, t)

View Source

Specs

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

retweeter_ids(arg1)

View Source

Specs

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

retweeter_ids(arg1, t)

View Source

Specs

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

retweets(arg1)

View Source

Specs

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

retweets(arg1, t)

View Source

Specs

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

retweets_of_me()

View Source

Specs

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

retweets_of_me(t)

View Source

Specs

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

reverse_geocode(float, float)

View Source

Specs

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

reverse_geocode(float, float, t)

View Source

Specs

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

search(t)

View Source

Specs

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

search(t, t)

View Source

Specs

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

search_next_page(t)

View Source

Specs

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

sent_direct_messages()

View Source

Specs

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

sent_direct_messages(t)

View Source

Specs

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

show(arg1)

View Source

Specs

show(integer() | String.t()) :: ExTwitter.Model.Tweet.t()
Link to this callback

show(arg1, t)

View Source

Specs

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

stream_control(pid, stream_control_type)

View Source

Specs

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

stream_control(pid, stream_control_type, list)

View Source

Specs

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

stream_filter(t)

View Source

Specs

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

stream_filter(t, timeout)

View Source

Specs

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

stream_sample()

View Source

Specs

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

stream_sample(t)

View Source

Specs

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

stream_user()

View Source

Specs

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

stream_user(t)

View Source

Specs

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

stream_user(t, integer)

View Source

Specs

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

trends(arg1)

View Source

Specs

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

trends(arg1, t)

View Source

Specs

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

unblock(arg1)

View Source

Specs

unblock(String.t() | integer()) :: ExTwitter.Model.User.t()
Link to this callback

unfollow(arg1)

View Source

Specs

unfollow(String.t() | integer()) :: ExTwitter.Model.User.t()
Link to this callback

unretweet(integer)

View Source

Specs

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

unretweet(integer, t)

View Source

Specs

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

update(t)

View Source

Specs

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

update(t, t)

View Source

Specs

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

update_with_chunked_media(t, t, t)

View Source

Specs

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

update_with_chunked_media(t, t, t, t)

View Source

Specs

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

update_with_media(t, t)

View Source

Specs

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

update_with_media(t, t, t)

View Source

Specs

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

upload_media(t, t)

View Source

Specs

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

upload_media(t, t, integer)

View Source

Specs

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

user(arg1)

View Source

Specs

user(String.t() | integer()) :: ExTwitter.Model.User.t()
Link to this callback

user(arg1, t)

View Source

Specs

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

user_lookup(arg1)

View Source

Specs

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

user_lookup(arg1, t)

View Source

Specs

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

user_profile_banner(arg1)

View Source

Specs

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

user_search(t)

View Source

Specs

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

user_search(t, t)

View Source

Specs

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

user_timeline()

View Source

Specs

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

user_timeline(t)

View Source

Specs

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

verify_credentials()

View Source

Specs

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

verify_credentials(t)

View Source

Specs

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