-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Twitter JSON parser and types
--   
@package twitter-types
@version 0.6.0

module Web.Twitter.Types
type DateString = String
type UserId = Integer
type Friends = [UserId]
type URIString = Text
type UserName = Text
type StatusId = Integer
type LanguageCode = String
data StreamingAPI
SStatus :: Status -> StreamingAPI
SRetweetedStatus :: RetweetedStatus -> StreamingAPI
SEvent :: Event -> StreamingAPI
SDelete :: Delete -> StreamingAPI
SFriends :: Friends -> StreamingAPI
SUnknown :: Value -> StreamingAPI

-- | This type represents a Twitter tweet structure. See
--   <a>https://dev.twitter.com/docs/platform-objects/tweets</a>.
data Status
Status :: Maybe [Contributor] -> Maybe Coordinates -> DateString -> Maybe UserId -> Maybe Entities -> Maybe Entities -> Integer -> Maybe Bool -> Maybe Text -> StatusId -> Maybe Text -> Maybe StatusId -> Maybe UserId -> Maybe LanguageCode -> Maybe Place -> Maybe Bool -> Maybe Object -> Integer -> Maybe Bool -> Maybe Status -> Text -> Text -> Bool -> User -> Maybe Bool -> Maybe [Text] -> Maybe Text -> Status
statusContributors :: Status -> Maybe [Contributor]
statusCoordinates :: Status -> Maybe Coordinates
statusCreatedAt :: Status -> DateString
statusCurrentUserRetweet :: Status -> Maybe UserId
statusEntities :: Status -> Maybe Entities
statusExtendedEntities :: Status -> Maybe Entities
statusFavoriteCount :: Status -> Integer
statusFavorited :: Status -> Maybe Bool
statusFilterLevel :: Status -> Maybe Text
statusId :: Status -> StatusId
statusInReplyToScreenName :: Status -> Maybe Text
statusInReplyToStatusId :: Status -> Maybe StatusId
statusInReplyToUserId :: Status -> Maybe UserId
statusLang :: Status -> Maybe LanguageCode
statusPlace :: Status -> Maybe Place
statusPossiblySensitive :: Status -> Maybe Bool
statusScopes :: Status -> Maybe Object
statusRetweetCount :: Status -> Integer
statusRetweeted :: Status -> Maybe Bool
statusRetweetedStatus :: Status -> Maybe Status
statusSource :: Status -> Text
statusText :: Status -> Text
statusTruncated :: Status -> Bool
statusUser :: Status -> User
statusWithheldCopyright :: Status -> Maybe Bool
statusWithheldInCountries :: Status -> Maybe [Text]
statusWithheldScope :: Status -> Maybe Text
data SearchResult body
SearchResult :: body -> SearchMetadata -> SearchResult body
searchResultStatuses :: SearchResult body -> body
searchResultSearchMetadata :: SearchResult body -> SearchMetadata
data SearchStatus
SearchStatus :: DateString -> StatusId -> Text -> Text -> User -> Maybe Coordinates -> SearchStatus
searchStatusCreatedAt :: SearchStatus -> DateString
searchStatusId :: SearchStatus -> StatusId
searchStatusText :: SearchStatus -> Text
searchStatusSource :: SearchStatus -> Text
searchStatusUser :: SearchStatus -> User
searchStatusCoordinates :: SearchStatus -> Maybe Coordinates
data SearchMetadata
SearchMetadata :: StatusId -> StatusId -> URIString -> Maybe URIString -> Int -> Maybe Float -> String -> String -> String -> SearchMetadata
searchMetadataMaxId :: SearchMetadata -> StatusId
searchMetadataSinceId :: SearchMetadata -> StatusId
searchMetadataRefreshURL :: SearchMetadata -> URIString
searchMetadataNextResults :: SearchMetadata -> Maybe URIString
searchMetadataCount :: SearchMetadata -> Int
searchMetadataCompletedIn :: SearchMetadata -> Maybe Float
searchMetadataSinceIdStr :: SearchMetadata -> String
searchMetadataQuery :: SearchMetadata -> String
searchMetadataMaxIdStr :: SearchMetadata -> String
data RetweetedStatus
RetweetedStatus :: DateString -> StatusId -> Text -> Text -> Bool -> Maybe Entities -> User -> Status -> Maybe Coordinates -> RetweetedStatus
rsCreatedAt :: RetweetedStatus -> DateString
rsId :: RetweetedStatus -> StatusId
rsText :: RetweetedStatus -> Text
rsSource :: RetweetedStatus -> Text
rsTruncated :: RetweetedStatus -> Bool
rsEntities :: RetweetedStatus -> Maybe Entities
rsUser :: RetweetedStatus -> User
rsRetweetedStatus :: RetweetedStatus -> Status
rsCoordinates :: RetweetedStatus -> Maybe Coordinates
data DirectMessage
DirectMessage :: DateString -> Text -> User -> Text -> Text -> StatusId -> User -> UserId -> UserId -> Maybe Coordinates -> DirectMessage
dmCreatedAt :: DirectMessage -> DateString
dmSenderScreenName :: DirectMessage -> Text
dmSender :: DirectMessage -> User
dmText :: DirectMessage -> Text
dmRecipientScreeName :: DirectMessage -> Text
dmId :: DirectMessage -> StatusId
dmRecipient :: DirectMessage -> User
dmRecipientId :: DirectMessage -> UserId
dmSenderId :: DirectMessage -> UserId
dmCoordinates :: DirectMessage -> Maybe Coordinates
data EventTarget
ETUser :: User -> EventTarget
ETStatus :: Status -> EventTarget
ETList :: List -> EventTarget
ETUnknown :: Value -> EventTarget
data Event
Event :: DateString -> Maybe EventTarget -> Text -> EventTarget -> EventTarget -> Event
evCreatedAt :: Event -> DateString
evTargetObject :: Event -> Maybe EventTarget
evEvent :: Event -> Text
evTarget :: Event -> EventTarget
evSource :: Event -> EventTarget
data Delete
Delete :: StatusId -> UserId -> Delete
delId :: Delete -> StatusId
delUserId :: Delete -> UserId

-- | This type represents the Twitter user. See
--   <a>https://dev.twitter.com/docs/platform-objects/users</a>.
data User
User :: Bool -> DateString -> Bool -> Bool -> Maybe Text -> Int -> Maybe Bool -> Maybe Bool -> Int -> Int -> Bool -> UserId -> Bool -> LanguageCode -> Int -> Maybe Text -> Text -> Maybe Bool -> Maybe Text -> Maybe URIString -> Maybe URIString -> Maybe Bool -> Maybe URIString -> Maybe URIString -> Maybe URIString -> Text -> Text -> Text -> Text -> Bool -> Bool -> Text -> Maybe Bool -> Int -> Maybe Text -> Maybe URIString -> Maybe Int -> Bool -> Maybe Text -> Maybe Text -> User
userContributorsEnabled :: User -> Bool
userCreatedAt :: User -> DateString
userDefaultProfile :: User -> Bool
userDefaultProfileImage :: User -> Bool
userDescription :: User -> Maybe Text
userFavoritesCount :: User -> Int
userFollowRequestSent :: User -> Maybe Bool
userFollowing :: User -> Maybe Bool
userFollowersCount :: User -> Int
userFriendsCount :: User -> Int
userGeoEnabled :: User -> Bool
userId :: User -> UserId
userIsTranslator :: User -> Bool
userLang :: User -> LanguageCode
userListedCount :: User -> Int
userLocation :: User -> Maybe Text
userName :: User -> Text
userNotifications :: User -> Maybe Bool
userProfileBackgroundColor :: User -> Maybe Text
userProfileBackgroundImageURL :: User -> Maybe URIString
userProfileBackgroundImageURLHttps :: User -> Maybe URIString
userProfileBackgroundTile :: User -> Maybe Bool
userProfileBannerURL :: User -> Maybe URIString
userProfileImageURL :: User -> Maybe URIString
userProfileImageURLHttps :: User -> Maybe URIString
userProfileLinkColor :: User -> Text
userProfileSidebarBorderColor :: User -> Text
userProfileSidebarFillColor :: User -> Text
userProfileTextColor :: User -> Text
userProfileUseBackgroundImage :: User -> Bool
userProtected :: User -> Bool
userScreenName :: User -> Text
userShowAllInlineMedia :: User -> Maybe Bool
userStatusesCount :: User -> Int
userTimeZone :: User -> Maybe Text
userURL :: User -> Maybe URIString
userUtcOffset :: User -> Maybe Int
userVerified :: User -> Bool
userWithheldInCountries :: User -> Maybe Text
userWithheldScope :: User -> Maybe Text
data List
List :: Int -> Text -> Text -> Int -> Int -> Text -> User -> List
listId :: List -> Int
listName :: List -> Text
listFullName :: List -> Text
listMemberCount :: List -> Int
listSubscriberCount :: List -> Int
listMode :: List -> Text
listUser :: List -> User

-- | Entity handling. See
--   <a>https://dev.twitter.com/docs/platform-objects/entities</a>.
data Entities
Entities :: [Entity HashTagEntity] -> [Entity UserEntity] -> [Entity URLEntity] -> [Entity MediaEntity] -> Entities
enHashTags :: Entities -> [Entity HashTagEntity]
enUserMentions :: Entities -> [Entity UserEntity]
enURLs :: Entities -> [Entity URLEntity]
enMedia :: Entities -> [Entity MediaEntity]

-- | The character positions the Entity was extracted from
--   
--   This is experimental implementation. This may be replaced by more
--   definite types.
type EntityIndices = [Int]
data Entity a
Entity :: a -> EntityIndices -> Entity a

-- | The detail information of the specific entity types (HashTag, URL,
--   User)
entityBody :: Entity a -> a

-- | The character positions the Entity was extracted from
entityIndices :: Entity a -> EntityIndices

-- | Hashtag entity. See
--   <a>https://dev.twitter.com/docs/platform-objects/entities#obj-hashtags</a>.
data HashTagEntity
HashTagEntity :: Text -> HashTagEntity

-- | The Hashtag text
hashTagText :: HashTagEntity -> Text

-- | User mention entity. See
--   <a>https://dev.twitter.com/docs/platform-objects/entities#obj-usermention</a>.
data UserEntity
UserEntity :: UserId -> UserName -> Text -> UserEntity
userEntityUserId :: UserEntity -> UserId
userEntityUserName :: UserEntity -> UserName
userEntityUserScreenName :: UserEntity -> Text

-- | URL entity. See
--   <a>https://dev.twitter.com/docs/platform-objects/entities#obj-url</a>.
data URLEntity
URLEntity :: URIString -> URIString -> Text -> URLEntity

-- | The URL that was extracted
ueURL :: URLEntity -> URIString

-- | The fully resolved URL (only for t.co links)
ueExpanded :: URLEntity -> URIString

-- | Not a URL but a string to display instead of the URL (only for t.co
--   links)
ueDisplay :: URLEntity -> Text
data MediaEntity
MediaEntity :: Text -> StatusId -> HashMap Text MediaSize -> URIString -> URIString -> URLEntity -> MediaEntity
meType :: MediaEntity -> Text
meId :: MediaEntity -> StatusId
meSizes :: MediaEntity -> HashMap Text MediaSize
meMediaURL :: MediaEntity -> URIString
meMediaURLHttps :: MediaEntity -> URIString
meURL :: MediaEntity -> URLEntity

-- | Size entity. See
--   <a>https://dev.twitter.com/docs/platform-objects/entities#obj-size</a>.
data MediaSize
MediaSize :: Int -> Int -> Text -> MediaSize
msWidth :: MediaSize -> Int
msHeight :: MediaSize -> Int
msResize :: MediaSize -> Text
data Coordinates
Coordinates :: [Double] -> Text -> Coordinates
coordinates :: Coordinates -> [Double]
coordinatesType :: Coordinates -> Text

-- | This type represents a place, named locations with corresponding geo
--   coordinates. See
--   <a>https://dev.twitter.com/docs/platform-objects/places</a>.
data Place
Place :: HashMap Text Text -> BoundingBox -> Text -> Text -> Text -> Text -> Text -> Text -> Text -> Place
placeAttributes :: Place -> HashMap Text Text
placeBoundingBox :: Place -> BoundingBox
placeCountry :: Place -> Text
placeCountryCode :: Place -> Text
placeFullName :: Place -> Text
placeId :: Place -> Text
placeName :: Place -> Text
placeType :: Place -> Text
placeURL :: Place -> Text

-- | A bounding box of coordinates which encloses the place. See
--   <a>https://dev.twitter.com/docs/platform-objects/places#obj-boundingbox</a>.
data BoundingBox
BoundingBox :: [[[Double]]] -> Text -> BoundingBox
boundingBoxCoordinates :: BoundingBox -> [[[Double]]]
boundingBoxType :: BoundingBox -> Text
data Contributor
Contributor :: UserId -> Text -> Contributor
contributorId :: Contributor -> UserId
contributorScreenName :: Contributor -> Text

-- | This type is represents the API response of "/1.1/media/upload.json".
--   See
--   <a>https://dev.twitter.com/docs/api/multiple-media-extended-entities</a>.
data UploadedMedia
UploadedMedia :: Integer -> Integer -> ImageSizeType -> UploadedMedia
uploadedMediaId :: UploadedMedia -> Integer
uploadedMediaSize :: UploadedMedia -> Integer
uploadedMediaImage :: UploadedMedia -> ImageSizeType

-- | Image size type. This type is included in the API response of
--   "/1.1/media/upload.json".
data ImageSizeType
ImageSizeType :: Int -> Int -> Text -> ImageSizeType
imageSizeTypeWidth :: ImageSizeType -> Int
imageSizeTypeHeight :: ImageSizeType -> Int
imageSizeTypeType :: ImageSizeType -> Text
checkError :: Object -> Parser ()
instance Show SearchMetadata
instance Eq SearchMetadata
instance Show body => Show (SearchResult body)
instance Eq body => Eq (SearchResult body)
instance Show EventType
instance Eq EventType
instance Show Delete
instance Eq Delete
instance Show User
instance Eq User
instance Show List
instance Eq List
instance Show HashTagEntity
instance Eq HashTagEntity
instance Show UserEntity
instance Eq UserEntity
instance Show URLEntity
instance Eq URLEntity
instance Show MediaSize
instance Eq MediaSize
instance Show MediaEntity
instance Eq MediaEntity
instance Show Coordinates
instance Eq Coordinates
instance Show DirectMessage
instance Eq DirectMessage
instance Show SearchStatus
instance Eq SearchStatus
instance Show BoundingBox
instance Eq BoundingBox
instance Show Place
instance Eq Place
instance Show a => Show (Entity a)
instance Eq a => Eq (Entity a)
instance Show Entities
instance Eq Entities
instance Show Contributor
instance Eq Contributor
instance Show Status
instance Eq Status
instance Show EventTarget
instance Eq EventTarget
instance Show Event
instance Eq Event
instance Show RetweetedStatus
instance Eq RetweetedStatus
instance Show StreamingAPI
instance Eq StreamingAPI
instance Show ImageSizeType
instance Show UploadedMedia
instance FromJSON UploadedMedia
instance FromJSON ImageSizeType
instance FromJSON Contributor
instance FromJSON a => FromJSON (Entity a)
instance FromJSON Entities
instance FromJSON BoundingBox
instance FromJSON Place
instance FromJSON Coordinates
instance FromJSON MediaSize
instance FromJSON MediaEntity
instance FromJSON URLEntity
instance FromJSON UserEntity
instance FromJSON HashTagEntity
instance FromJSON List
instance FromJSON User
instance FromJSON Delete
instance FromJSON Event
instance FromJSON EventTarget
instance FromJSON DirectMessage
instance FromJSON RetweetedStatus
instance FromJSON SearchMetadata
instance FromJSON SearchStatus
instance FromJSON body => FromJSON (SearchResult body)
instance FromJSON Status
instance FromJSON StreamingAPI