Safe Haskell | None |
---|---|
Language | Haskell98 |
- getResponse :: MonadResource m => TWInfo -> Manager -> Request -> m (Response (ResumableSource m ByteString))
- call :: (MonadResource m, FromJSON responseType) => TWInfo -> Manager -> APIRequest apiName responseType -> m responseType
- call' :: (MonadResource m, FromJSON value) => TWInfo -> Manager -> APIRequest apiName responseType -> m value
- callWithResponse :: (MonadResource m, FromJSON responseType) => TWInfo -> Manager -> APIRequest apiName responseType -> m (Response responseType)
- callWithResponse' :: (MonadResource m, FromJSON value) => TWInfo -> Manager -> APIRequest apiName responseType -> m (Response value)
- checkResponse :: Response Value -> Either TwitterError Value
- sourceWithMaxId :: (MonadResource m, FromJSON responseType, AsStatus responseType, HasMaxIdParam (APIRequest apiName [responseType])) => TWInfo -> Manager -> APIRequest apiName [responseType] -> Source m responseType
- sourceWithMaxId' :: (MonadResource m, HasMaxIdParam (APIRequest apiName [responseType])) => TWInfo -> Manager -> APIRequest apiName [responseType] -> Source m Value
- sourceWithCursor :: (MonadResource m, FromJSON responseType, CursorKey ck, HasCursorParam (APIRequest apiName (WithCursor ck responseType))) => TWInfo -> Manager -> APIRequest apiName (WithCursor ck responseType) -> Source m responseType
- sourceWithCursor' :: (MonadResource m, FromJSON responseType, CursorKey ck, HasCursorParam (APIRequest apiName (WithCursor ck responseType))) => TWInfo -> Manager -> APIRequest apiName (WithCursor ck responseType) -> Source m Value
- sourceWithSearchResult :: (MonadResource m, FromJSON responseType, HasMaxIdParam (APIRequest apiName (SearchResult [responseType]))) => TWInfo -> Manager -> APIRequest apiName (SearchResult [responseType]) -> m (SearchResult (Source m responseType))
- sourceWithSearchResult' :: (MonadResource m, HasMaxIdParam (APIRequest apiName (SearchResult [responseType]))) => TWInfo -> Manager -> APIRequest apiName (SearchResult [responseType]) -> m (SearchResult (Source m Value))
- type TwitterBaseM m = MonadResource m
- endpoint :: String
- makeRequest :: APIRequest apiName responseType -> IO Request
- sinkJSON :: MonadThrow m => Consumer ByteString m Value
- sinkFromJSON :: (FromJSON a, MonadThrow m) => Consumer ByteString m a
Documentation
getResponse :: MonadResource m => TWInfo -> Manager -> Request -> m (Response (ResumableSource m ByteString)) Source
:: (MonadResource m, FromJSON responseType) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName responseType | |
-> m responseType |
Perform an APIRequest
and then provide the response which is mapped to a suitable type of
twitter-types.
Example:
withManager
$ \mgr -> do user <-call
twInfo mgr $accountVerifyCredentials
liftIO
$ print user
If you need raw JSON value which is parsed by aeson,
use call'
to obtain it.
:: (MonadResource m, FromJSON value) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName responseType | |
-> m value |
Perform an APIRequest
and then provide the response.
The response of this function is not restrict to responseType
,
so you can choose an arbitrarily type of FromJSON instances.
:: (MonadResource m, FromJSON responseType) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName responseType | |
-> m (Response responseType) |
Perform an APIRequest
and then provide the Response
.
Example:
res <-withManager
$ \mgr -> docallWithResponse
twInfo mgr $accountVerifyCredentials
responseStatus
resresponseHeaders
resresponseBody
res
callWithResponse' :: (MonadResource m, FromJSON value) => TWInfo -> Manager -> APIRequest apiName responseType -> m (Response value) Source
Perform an APIRequest
and then provide the Response
.
The response of this function is not restrict to responseType
,
so you can choose an arbitrarily type of FromJSON instances.
Example:
res <-withManager
$ \mgr -> docallWithResponse'
twInfo mgr $accountVerifyCredentials
responseStatus
resresponseHeaders
resresponseBody
(res :: Value)
:: (MonadResource m, FromJSON responseType, AsStatus responseType, HasMaxIdParam (APIRequest apiName [responseType])) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName [responseType] | |
-> Source m responseType |
A wrapper function to perform multiple API request with changing max_id
parameter.
This function cooperate with instances of HasMaxIdParam
.
:: (MonadResource m, HasMaxIdParam (APIRequest apiName [responseType])) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName [responseType] | |
-> Source m Value |
A wrapper function to perform multiple API request with changing max_id
parameter.
The response of this function is not restrict to responseType
,
so you can choose an arbitrarily type of FromJSON instances.
This function cooperate with instances of HasMaxIdParam
.
:: (MonadResource m, FromJSON responseType, CursorKey ck, HasCursorParam (APIRequest apiName (WithCursor ck responseType))) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName (WithCursor ck responseType) | |
-> Source m responseType |
A wrapper function to perform multiple API request with changing cursor
parameter.
This function cooperate with instances of HasCursorParam
.
:: (MonadResource m, FromJSON responseType, CursorKey ck, HasCursorParam (APIRequest apiName (WithCursor ck responseType))) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName (WithCursor ck responseType) | |
-> Source m Value |
A wrapper function to perform multiple API request with changing cursor
parameter.
The response of this function is not restrict to responseType
,
so you can choose an arbitrarily type of FromJSON instances.
This function cooperate with instances of HasCursorParam
.
:: (MonadResource m, FromJSON responseType, HasMaxIdParam (APIRequest apiName (SearchResult [responseType]))) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName (SearchResult [responseType]) | |
-> m (SearchResult (Source m responseType)) |
A wrapper function to perform multiple API request with SearchResult
.
sourceWithSearchResult' Source
:: (MonadResource m, HasMaxIdParam (APIRequest apiName (SearchResult [responseType]))) | |
=> TWInfo | Twitter Setting |
-> Manager | |
-> APIRequest apiName (SearchResult [responseType]) | |
-> m (SearchResult (Source m Value)) |
A wrapper function to perform multiple API request with SearchResult
.
type TwitterBaseM m = MonadResource m Source
makeRequest :: APIRequest apiName responseType -> IO Request Source
sinkJSON :: MonadThrow m => Consumer ByteString m Value Source
sinkFromJSON :: (FromJSON a, MonadThrow m) => Consumer ByteString m a Source