Safe Haskell	None

Web.Twitter.Conduit.Api

Contents

Search
Direct Messages
Friends & Followers
Users
Suggested Users
Favorites
Lists

Synopsis

Search

data Search Source

Instances

HasCountParam (APIRequest Search a0)
HasSinceIdParam (APIRequest Search a0)
HasMaxIdParam (APIRequest Search a0)
HasIncludeEntitiesParam (APIRequest Search a0)
HasLangParam (APIRequest Search a0)
HasLocaleParam (APIRequest Search a0)
HasUntilParam (APIRequest Search a0)

search Source

Arguments

:: Text	search string
-> APIRequest Search (SearchResult [SearchStatus])

Returns search query.

You can perform a search query using call:

 res <- call (search "search text")
 liftIO . print $ res ^. searchResultStatuses

>>> search "search text"
APIRequestGet "https://api.twitter.com/1.1/search/tweets.json" [("q","search text")]
>>> search "search text" & lang ?~ "ja" & count ?~ 100
APIRequestGet "https://api.twitter.com/1.1/search/tweets.json" [("count","100"),("lang","ja"),("q","search text")]

Direct Messages

data DirectMessages Source

Instances

HasCountParam (APIRequest DirectMessages a0)
HasSinceIdParam (APIRequest DirectMessages a0)
HasMaxIdParam (APIRequest DirectMessages a0)
HasIncludeEntitiesParam (APIRequest DirectMessages a0)
HasSkipStatusParam (APIRequest DirectMessages a0)

directMessages :: APIRequest DirectMessages [DirectMessage]Source

Returns query data which asks recent direct messages sent to the authenticating user.

You can perform a query using call:

 res <- call $ directMessages & count ?~ 100

>>> directMessages
APIRequestGet "https://api.twitter.com/1.1/direct_messages.json" []
>>> directMessages & count ?~ 100
APIRequestGet "https://api.twitter.com/1.1/direct_messages.json" [("count","100")]

directMessagesSent :: APIRequest DirectMessagesSent [DirectMessage]Source

Returns query data which asks recent direct messages sent by the authenticating user.

You can perform a query using call:

 res <- call $ directMessagesSent & count ?~ 100

>>> directMessagesSent
APIRequestGet "https://api.twitter.com/1.1/direct_messages/sent.json" []
>>> directMessagesSent & count ?~ 100
APIRequestGet "https://api.twitter.com/1.1/direct_messages/sent.json" [("count","100")]

data DirectMessagesShow Source

directMessagesShow :: StatusId -> APIRequest DirectMessagesShow DirectMessage Source

Returns query data which asks a single direct message, specified by an id parameter.

You can perform a query using call:

 res <- call $ directMessagesShow 1234567890

>>> directMessagesShow 1234567890
APIRequestGet "https://api.twitter.com/1.1/direct_messages/show.json" [("id","1234567890")]

data DirectMessagesDestroy Source

Instances

HasIncludeEntitiesParam (APIRequest DirectMessagesDestroy a0)

directMessagesDestroy :: StatusId -> APIRequest DirectMessagesDestroy DirectMessage Source

Returns post data which destroys the direct message specified in the required ID parameter.

You can perform a query using call:

 res <- call $ directMessagesDestroy 1234567890

>>> directMessagesDestroy 1234567890
APIRequestPost "https://api.twitter.com/1.1/direct_messages/destroy.json" [("id","1234567890")]

data DirectMessagesNew Source

directMessagesNew :: UserParam -> Text -> APIRequest DirectMessagesNew DirectMessage Source

Returns post data which sends a new direct message to the specified user from the authenticating user.

You can perform a post using call:

 res <- call $ directMessagesNew (ScreenNameParam "thimura") "Hello DM"

>>> directMessagesNew (ScreenNameParam "thimura") "Hello DM"
APIRequestPost "https://api.twitter.com/1.1/direct_messages/new.json" [("text","Hello DM"),("screen_name","thimura")]
>>> directMessagesNew (UserIdParam 69179963) "Hello thimura! by UserId"
APIRequestPost "https://api.twitter.com/1.1/direct_messages/new.json" [("text","Hello thimura! by UserId"),("user_id","69179963")]

Friends & Followers

data FriendsIds Source

Instances

HasCountParam (APIRequest FriendsIds a0)
HasCursorParam (APIRequest FriendsIds a0)

friendsIds :: UserParam -> APIRequest FriendsIds (WithCursor IdsCursorKey UserId)Source

Returns query data which asks a collection of user IDs for every user the specified user is following.

You can perform a query using call:

 res <- call $ friendsIds (ScreenNameParam "thimura")

Or, you can iterate with sourceWithCursor:

 sourceWithCursor (friendsIds (ScreenNameParam "thimura")) $$ CL.consume

>>> friendsIds (ScreenNameParam "thimura")
APIRequestGet "https://api.twitter.com/1.1/friends/ids.json" [("screen_name","thimura")]
>>> friendsIds (ScreenNameParam "thimura") & count ?~ 5000
APIRequestGet "https://api.twitter.com/1.1/friends/ids.json" [("count","5000"),("screen_name","thimura")]

data FollowersIds Source

Instances

HasCountParam (APIRequest FollowersIds a0)
HasCursorParam (APIRequest FollowersIds a0)

followersIds :: UserParam -> APIRequest FollowersIds (WithCursor IdsCursorKey UserId)Source

Returns query data which asks a collection of user IDs for every user following the specified user.

You can perform a query using call:

 res <- call $ followersIds (ScreenNameParam "thimura")

Or, you can iterate with sourceWithCursor:

 sourceWithCursor (followersIds (ScreenNameParam "thimura")) $$ CL.consume

>>> followersIds (ScreenNameParam "thimura")
APIRequestGet "https://api.twitter.com/1.1/followers/ids.json" [("screen_name","thimura")]
>>> followersIds (ScreenNameParam "thimura") & count ?~ 5000
APIRequestGet "https://api.twitter.com/1.1/followers/ids.json" [("count","5000"),("screen_name","thimura")]

data FriendshipsCreate Source

Instances

HasFollowParam (APIRequest FriendshipsCreate a0)

friendshipsCreate :: UserParam -> APIRequest FriendshipsCreate User Source

Returns post data which follows the user specified in the ID parameter.

You can perform request by using call:

 res <- call $ friendshipsCreate (ScreenNameParam "thimura")

>>> friendshipsCreate (ScreenNameParam "thimura")
APIRequestPost "https://api.twitter.com/1.1/friendships/create.json" [("screen_name","thimura")]
>>> friendshipsCreate (UserIdParam 69179963)
APIRequestPost "https://api.twitter.com/1.1/friendships/create.json" [("user_id","69179963")]

data FriendsList Source

Instances

HasCountParam (APIRequest FriendsList a0)
HasCursorParam (APIRequest FriendsList a0)
HasIncludeUserEntitiesParam (APIRequest FriendsList a0)
HasSkipStatusParam (APIRequest FriendsList a0)

friendsList :: UserParam -> APIRequest FriendsList (WithCursor UsersCursorKey User)Source

Returns query data which asks a cursored collection of user objects for every user the specified users is following.

You can perform request by using call:

 res <- call $ friendsList (ScreenNameParam "thimura")

Or, you can iterate with sourceWithCursor:

 sourceWithCursor (friendsList (ScreenNameParam "thimura")) $$ CL.consume

>>> friendsList (ScreenNameParam "thimura")
APIRequestGet "https://api.twitter.com/1.1/friends/list.json" [("screen_name","thimura")]
>>> friendsList (UserIdParam 69179963)
APIRequestGet "https://api.twitter.com/1.1/friends/list.json" [("user_id","69179963")]

Users

data AccountVerifyCredentials Source

Instances

HasIncludeEntitiesParam (APIRequest AccountVerifyCredentials a0)
HasSkipStatusParam (APIRequest AccountVerifyCredentials a0)

accountVerifyCredentials :: APIRequest AccountVerifyCredentials User Source

Returns query data asks that the credential is valid.

You can perform request by using call:

 res <- call $ accountVerifyCredentials

>>> accountVerifyCredentials
APIRequestGet "https://api.twitter.com/1.1/account/verify_credentials.json" []

data UsersLookup Source

Instances

HasIncludeEntitiesParam (APIRequest UsersLookup a0)

usersLookup :: UserListParam -> APIRequest UsersLookup [User]Source

Returns query data asks user objects.

You can perform request by using call:

 res <- call $ usersLookup (ScreenNameListParam ["thimura", "twitterapi"])

>>> usersLookup (ScreenNameListParam ["thimura", "twitterapi"])
APIRequestGet "https://api.twitter.com/1.1/users/lookup.json" [("screen_name","thimura,twitterapi")]

data UsersShow Source

Instances

HasIncludeEntitiesParam (APIRequest UsersShow a0)

usersShow :: UserParam -> APIRequest UsersShow User Source

Returns query data asks the user specified by user id or screen name parameter.

You can perform request by using call:

 res <- call $ usersShow (ScreenNameParam "thimura")

>>> usersShow (ScreenNameParam "thimura")
APIRequestGet "https://api.twitter.com/1.1/users/show.json" [("screen_name","thimura")]

Suggested Users

Favorites

data FavoritesDestroy Source

Instances

HasIncludeEntitiesParam (APIRequest FavoritesDestroy a0)

favoritesDestroy :: StatusId -> APIRequest FavoritesDestroy Status Source

Returns post data unfavorites the status specified in the ID paramter as the authenticating user.

You can perform request by using call:

 res <- call $ favoritesDestroy 1234567890

>>> favoritesDestroy 1234567890
APIRequestPost "https://api.twitter.com/1.1/favorites/destroy.json" [("id","1234567890")]

data FavoritesCreate Source

Instances

HasIncludeEntitiesParam (APIRequest FavoritesCreate a0)

favoritesCreate :: StatusId -> APIRequest FavoritesCreate Status Source

Returns post data which favorites the status specified in the ID parameter as the authenticating user.

You can perform request by using call:

 res <- call $ favoritesCreate 1234567890

>>> favoritesCreate 1234567890
APIRequestPost "https://api.twitter.com/1.1/favorites/create.json" [("id","1234567890")]

Lists

data ListsMembers Source

Instances

HasCursorParam (APIRequest ListsMembers a0)
HasSkipStatusParam (APIRequest ListsMembers a0)

listsMembers :: ListParam -> APIRequest ListsMembers (WithCursor UsersCursorKey User)Source

Returns query data asks the members of the specified list.

You can perform request by using call:

 res <- call $ listsMembers (ListNameParam thimura/haskell)

>>> listsMembers (ListNameParam "thimura/haskell")
APIRequestGet "https://api.twitter.com/1.1/lists/members.json" [("slug","haskell"),("owner_screen_name","thimura")]
>>> listsMembers (ListIdParam 20849097)
APIRequestGet "https://api.twitter.com/1.1/lists/members.json" [("list_id","20849097")]

HasCountParam (APIRequest DirectMessagesSent a0)
HasSinceIdParam (APIRequest DirectMessagesSent a0)
HasMaxIdParam (APIRequest DirectMessagesSent a0)
HasPageParam (APIRequest DirectMessagesSent a0)
HasIncludeEntitiesParam (APIRequest DirectMessagesSent a0)
HasSkipStatusParam (APIRequest DirectMessagesSent a0)