twitter-conduit-0.4.0: Twitter API package with conduit interface and Streaming API support.

Safe HaskellNone
LanguageHaskell2010

Web.Twitter.Conduit.Request

Synopsis

Documentation

class Parameters a where Source #

Instances
Parameters (APIRequest apiName responseType) Source # 
Instance details

Defined in Web.Twitter.Conduit.Request

Methods

params :: Lens' (APIRequest apiName responseType) APIQuery Source #

data APIRequest apiName responseType Source #

API request. You should use specific builder functions instead of building this directly.

For example, if there were a SampleApi type and a builder function which named sampleApiRequest. In addition, APIRequest SampleApi [SampleId] is a instance of both of HasCountParam and HasMaxIdParam.

data SampleApi
type SampleId = Integer
instance HasCountParam (APIRequest SampleApi [SampleId])
instance HasMaxIdParam (APIRequest SampleApi [SampleId])
sampleApiRequest :: APIRequest SampleApi [SampleId]
sampleApiRequest = APIRequest "GET" "https://api.twitter.com/sample/api.json" def

We can obtain request params from APIRequest SampleApi [SampleId] :

>>> sampleApiRequest ^. params
[]

And update request parameters.

>>> (sampleApiRequest & count ?~ 100 & maxId ?~ 1234567890) ^. params
[("max_id",PVInteger {unPVInteger = 1234567890}),("count",PVInteger {unPVInteger = 100})]
>>> (sampleApiRequest & count ?~ 100 & maxId ?~ 1234567890 & count .~ Nothing) ^. params
[("max_id",PVInteger {unPVInteger = 1234567890})]
Instances
Show (APIRequest apiName responseType) Source # 
Instance details

Defined in Web.Twitter.Conduit.Request

Methods

showsPrec :: Int -> APIRequest apiName responseType -> ShowS #

show :: APIRequest apiName responseType -> String #

showList :: [APIRequest apiName responseType] -> ShowS #

HasCountParam (APIRequest StatusesMentionsTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasCountParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasCountParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasCountParam (APIRequest StatusesRetweetsOfMe a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasCountParam (APIRequest StatusesRetweetsId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasCountParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest DirectMessages a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest FriendsIds a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest FollowersIds a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest FriendsList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest FollowersList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest FavoritesList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest ListsStatuses a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest ListsMemberships a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest ListsSubscribers a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest ListsSubscriptions a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest ListsOwnerships a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCountParam (APIRequest ListsMembers a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSinceIdParam (APIRequest StatusesMentionsTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasSinceIdParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasSinceIdParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasSinceIdParam (APIRequest StatusesRetweetsOfMe a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasSinceIdParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSinceIdParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSinceIdParam (APIRequest FavoritesList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSinceIdParam (APIRequest ListsStatuses a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasMaxIdParam (APIRequest StatusesMentionsTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasMaxIdParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasMaxIdParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasMaxIdParam (APIRequest StatusesRetweetsOfMe a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasMaxIdParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasMaxIdParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasMaxIdParam (APIRequest FavoritesList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasMaxIdParam (APIRequest ListsStatuses a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasPageParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasTrimUserParam (APIRequest StatusesMentionsTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesRetweetsOfMe a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesRetweetsId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesShowId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesDestroyId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesUpdate a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesRetweetId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasTrimUserParam (APIRequest StatusesLookup a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasExcludeRepliesParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasExcludeRepliesParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasContributorDetailsParam (APIRequest StatusesMentionsTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasContributorDetailsParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasContributorDetailsParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeEntitiesParam (APIRequest StatusesMentionsTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeEntitiesParam (APIRequest StatusesHomeTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeEntitiesParam (APIRequest StatusesRetweetsOfMe a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeEntitiesParam (APIRequest StatusesShowId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeEntitiesParam (APIRequest StatusesLookup a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeEntitiesParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest DirectMessages a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest AccountVerifyCredentials a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest UsersLookup a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest UsersShow a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest FavoritesList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest FavoritesCreate a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest FavoritesDestroy a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEntitiesParam (APIRequest ListsStatuses a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeEmailParam (APIRequest AccountVerifyCredentials a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeUserEntitiesParam (APIRequest StatusesRetweetsOfMe a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeUserEntitiesParam (APIRequest FriendsList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeUserEntitiesParam (APIRequest FollowersList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeRtsParam (APIRequest StatusesUserTimeline a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeRtsParam (APIRequest ListsStatuses a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasIncludeMyRetweetParam (APIRequest StatusesShowId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasIncludeExtAltTextParam (APIRequest StatusesShowId a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasInReplyToStatusIdParam (APIRequest StatusesUpdate a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasInReplyToStatusIdParam (APIRequest StatusesUpdateWithMedia a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasDisplayCoordinatesParam (APIRequest StatusesUpdate a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasDisplayCoordinatesParam (APIRequest StatusesUpdateWithMedia a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasPossiblySensitiveParam (APIRequest StatusesUpdateWithMedia a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasLangParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasLanguageParam (APIRequest Userstream a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasLanguageParam (APIRequest StatusesFilter a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasLocaleParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasFilterLevelParam (APIRequest Userstream a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasFilterLevelParam (APIRequest StatusesFilter a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasStallWarningsParam (APIRequest Userstream a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasStallWarningsParam (APIRequest StatusesFilter a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasRepliesParam (APIRequest Userstream a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Stream

HasUntilParam (APIRequest SearchTweets a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest DirectMessages a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest FriendsList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest FollowersList a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest AccountVerifyCredentials a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest ListsSubscribers a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasSkipStatusParam (APIRequest ListsMembers a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasFollowParam (APIRequest FriendshipsCreate a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasMapParam (APIRequest StatusesLookup a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasMediaIdsParam (APIRequest StatusesUpdate a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Status

HasDescriptionParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasNameParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasProfileLinkColorParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasLocationParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasUrlParam (APIRequest AccountUpdateProfile a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasFullTextParam (APIRequest DirectMessages a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasFullTextParam (APIRequest DirectMessagesSent a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasFullTextParam (APIRequest DirectMessagesShow a) Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

Parameters (APIRequest apiName responseType) Source # 
Instance details

Defined in Web.Twitter.Conduit.Request

Methods

params :: Lens' (APIRequest apiName responseType) APIQuery Source #

HasCursorParam (APIRequest DirectMessages a) Text Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest FriendsIds a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest FollowersIds a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest FriendshipsOutgoing a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest FriendshipsIncoming a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest FriendsList a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest FollowersList a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest ListsMemberships a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest ListsSubscribers a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest ListsSubscriptions a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest ListsOwnerships a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

HasCursorParam (APIRequest ListsMembers a) Integer Source # 
Instance details

Defined in Web.Twitter.Conduit.Api

data PV Source #

Instances
Eq PV Source # 
Instance details

Defined in Web.Twitter.Conduit.Request

Methods

(==) :: PV -> PV -> Bool #

(/=) :: PV -> PV -> Bool #

Show PV Source # 
Instance details

Defined in Web.Twitter.Conduit.Request

Methods

showsPrec :: Int -> PV -> ShowS #

show :: PV -> String #

showList :: [PV] -> ShowS #