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

Safe Haskell | None
Language | Haskell2010

Web.Twitter.Conduit.Status

Contents

- Timelines
- Tweets

Synopsis

- type StatusesMentionsTimeline = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "contributor_details" := Bool, "include_entities" := Bool, "tweet_mode" := Text]
- mentionsTimeline :: APIRequest StatusesMentionsTimeline [Status]
- type StatusesUserTimeline = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "exclude_replies" := Bool, "contributor_details" := Bool, "include_rts" := Bool, "tweet_mode" := Text]
- userTimeline :: UserParam -> APIRequest StatusesUserTimeline [Status]
- type StatusesHomeTimeline = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "exclude_replies" := Bool, "contributor_details" := Bool, "include_entities" := Bool, "tweet_mode" := Text]
- homeTimeline :: APIRequest StatusesHomeTimeline [Status]
- type StatusesRetweetsOfMe = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "include_entities" := Bool, "include_user_entities" := Bool, "tweet_mode" := Text]
- retweetsOfMe :: APIRequest StatusesRetweetsOfMe [Status]
- type StatusesRetweetsId = '["count" := Integer, "trim_user" := Bool]
- retweetsId :: StatusId -> APIRequest StatusesRetweetsId [RetweetedStatus]
- type StatusesShowId = '["trim_user" := Bool, "include_my_retweet" := Bool, "include_entities" := Bool, "include_ext_alt_text" := Bool, "tweet_mode" := Text]
- showId :: StatusId -> APIRequest StatusesShowId Status
- type StatusesDestroyId = '["trim_user" := Bool, "tweet_mode" := Text]
- destroyId :: StatusId -> APIRequest StatusesDestroyId Status
- type StatusesUpdate = '["in_reply_to_status_id" := Integer, "display_coordinates" := Bool, "trim_user" := Bool, "media_ids" := [Integer], "tweet_mode" := Text]
- update :: Text -> APIRequest StatusesUpdate Status
- type StatusesRetweetId = '["trim_user" := Bool]
- retweetId :: StatusId -> APIRequest StatusesRetweetId RetweetedStatus
- data MediaData
  - = MediaFromFile FilePath
  - | MediaRequestBody FilePath RequestBody
- type StatusesUpdateWithMedia = '["possibly_sensitive" := Bool, "in_reply_to_status_id" := Integer, "display_coordinates" := Bool, "tweet_mode" := Text]
- updateWithMedia :: Text -> MediaData -> APIRequest StatusesUpdateWithMedia Status
- type StatusesLookup = '["include_entities" := Bool, "trim_user" := Bool, "map" := Bool, "tweet_mode" := Text]
- lookup :: [StatusId] -> APIRequest StatusesLookup [Status]

# Timelines

type StatusesMentionsTimeline = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "contributor_details" := Bool, "include_entities" := Bool, "tweet_mode" := Text] Source #

mentionsTimeline :: APIRequest StatusesMentionsTimeline [Status] Source #

Returns query data asks the most recent mentions for the authenticating user.

You can perform a query using `call`:

    res <- call mentionsTimeline

    >>> mentionsTimeline
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/mentions_timeline.json" []

type StatusesUserTimeline = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "exclude_replies" := Bool, "contributor_details" := Bool, "include_rts" := Bool, "tweet_mode" := Text] Source #

userTimeline :: UserParam -> APIRequest StatusesUserTimeline [Status] Source #

Returns query data asks a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters.

You can perform a search query using `call`:

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

    >>> userTimeline (ScreenNameParam "thimura")
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/user_timeline.json" [("screen_name","thimura")]
    >>> userTimeline (ScreenNameParam "thimura") & #include_rts ?~ True & #count ?~ 200
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/user_timeline.json" [("count","200"),("include_rts","true"),("screen_name","thimura")]

type StatusesHomeTimeline = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "exclude_replies" := Bool, "contributor_details" := Bool, "include_entities" := Bool, "tweet_mode" := Text] Source #

homeTimeline :: APIRequest StatusesHomeTimeline [Status] Source #

Returns query data asks a collection of the most recentTweets and retweets posted by the authenticating user and the users they follow.

You can perform a search query using `call`:

    res <- call homeTimeline

    >>> homeTimeline
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/home_timeline.json" []
    >>> homeTimeline & #count ?~ 200
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/home_timeline.json" [("count","200")]

type StatusesRetweetsOfMe = '["count" := Integer, "since_id" := Integer, "max_id" := Integer, "trim_user" := Bool, "include_entities" := Bool, "include_user_entities" := Bool, "tweet_mode" := Text] Source #

retweetsOfMe :: APIRequest StatusesRetweetsOfMe [Status] Source #

Returns query data asks the most recent tweets authored by the authenticating user that have been retweeted by others.

You can perform a search query using `call`:

    res <- call retweetsOfMe

    >>> retweetsOfMe
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/retweets_of_me.json" []
    >>> retweetsOfMe & #count ?~ 100
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/retweets_of_me.json" [("count","100")]

# Tweets

type StatusesRetweetsId = '["count" := Integer, "trim_user" := Bool] Source #

retweetsId :: StatusId -> APIRequest StatusesRetweetsId [RetweetedStatus] Source #

Returns query data that asks for the most recent retweets of the specified tweet

You can perform a search query using `call`:

    res <- call twInfo mgr $ retweetsId 1234567890

    >>> retweetsId 1234567890
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/retweets/1234567890.json" []
    >>> retweetsId 1234567890 & #count ?~ 100
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/retweets/1234567890.json" [("count","100")]

type StatusesShowId = '["trim_user" := Bool, "include_my_retweet" := Bool, "include_entities" := Bool, "include_ext_alt_text" := Bool, "tweet_mode" := Text] Source #

showId :: StatusId -> APIRequest StatusesShowId Status Source #

Returns query data asks a single Tweet, specified by the id parameter.

You can perform a search query using `call`:

    res <- call twInfo mgr $ showId 1234567890

    >>> showId 1234567890
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/show/1234567890.json" []
    >>> showId 1234567890 & #include_my_retweet ?~ True
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/show/1234567890.json" [("include_my_retweet","true")]

type StatusesDestroyId = '["trim_user" := Bool, "tweet_mode" := Text] Source #

destroyId :: StatusId -> APIRequest StatusesDestroyId Status Source #

Returns post data which destroys the status specified by the require ID parameter.

You can perform a search query using `call`:

    res <- call twInfo mgr $ destroyId 1234567890

    >>> destroyId 1234567890
    APIRequest "POST" "https://api.twitter.com/1.1/statuses/destroy/1234567890.json" []

type StatusesUpdate = '["in_reply_to_status_id" := Integer, "display_coordinates" := Bool, "trim_user" := Bool, "media_ids" := [Integer], "tweet_mode" := Text] Source #

update :: Text -> APIRequest StatusesUpdate Status Source #

Returns post data which updates the authenticating user's current status. To upload an image to accompany the tweet, use `updateWithMedia`.

You can perform a search query using `call`:

    res <- call twInfo mgr $ update "Hello World"

    >>> update "Hello World"
    APIRequest "POST" "https://api.twitter.com/1.1/statuses/update.json" [("status","Hello World")]
    >>> update "Hello World" & #in_reply_to_status_id ?~ 1234567890
    APIRequest "POST" "https://api.twitter.com/1.1/statuses/update.json" [("in_reply_to_status_id","1234567890"),("status","Hello World")]

type StatusesRetweetId = '["trim_user" := Bool] Source #

retweetId :: StatusId -> APIRequest StatusesRetweetId RetweetedStatus Source #

Returns post data which retweets a tweet, specified by ID.

You can perform a search query using `call`:

    res <- call twInfo mgr $ retweetId 1234567890

    >>> retweetId 1234567890
    APIRequest "POST" "https://api.twitter.com/1.1/statuses/retweet/1234567890.json" []

data MediaData Source #

Constructors

MediaFromFile FilePath |
MediaRequestBody FilePath RequestBody |

type StatusesUpdateWithMedia = '["possibly_sensitive" := Bool, "in_reply_to_status_id" := Integer, "display_coordinates" := Bool, "tweet_mode" := Text] Source #

updateWithMedia :: Text -> MediaData -> APIRequest StatusesUpdateWithMedia Status Source #

Returns post data which updates the authenticating user's current status and attaches media for upload.

You can perform a search query using `call`:

    res <- call twInfo mgr $ updateWithMedia "Hello World" (MediaFromFile "homethimura/test.jpeg")

    >>> updateWithMedia "Hello World" (MediaFromFile "/home/fuga/test.jpeg")
    APIRequestMultipart "POST" "https://api.twitter.com/1.1/statuses/update_with_media.json" [("status","Hello World")]

type StatusesLookup = '["include_entities" := Bool, "trim_user" := Bool, "map" := Bool, "tweet_mode" := Text] Source #

lookup :: [StatusId] -> APIRequest StatusesLookup [Status] Source #

Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by comma-separated values passed to the id parameter.

You can perform a request using `call`:

    res <- call twInfo mgr $ lookup [20, 432656548536401920]

    >>> lookup [10]
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/lookup.json" [("id","10")]
    >>> lookup [10, 432656548536401920]
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/lookup.json" [("id","10,432656548536401920")]
    >>> lookup [10, 432656548536401920] & #include_entities ?~ True
    APIRequest "GET" "https://api.twitter.com/1.1/statuses/lookup.json" [("include_entities","true"),("id","10,432656548536401920")]