Safe Haskell	None
Language	Haskell98

Web.Twitter.Conduit.Base

Synopsis

Documentation

getResponse :: MonadResource m => TWInfo -> Manager -> Request -> m (Response (ResumableSource m ByteString)) Source

call Source

Arguments

:: (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.

call' Source

Arguments

:: (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.

callWithResponse Source

Arguments

:: (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 -> do
    callWithResponse twInfo mgr $ accountVerifyCredentials
print $ responseStatus res
print $ responseHeaders res
print $ responseBody 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 -> do
    callWithResponse' twInfo mgr $ accountVerifyCredentials
print $ responseStatus res
print $ responseHeaders res
print $ responseBody (res :: Value)

checkResponse :: Response Value -> Either TwitterError Value Source

sourceWithMaxId Source

Arguments

:: (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.

sourceWithMaxId' Source

Arguments

:: (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.

sourceWithCursor Source

Arguments

:: (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.

sourceWithCursor' Source

Arguments

:: (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.

type TwitterBaseM m = MonadResource m Source

endpoint :: String 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