| Copyright | (c) 2021 Rory Tyler Hayford |
|---|---|
| License | BSD-3-Clause |
| Maintainer | rory.hayford@protonmail.com |
| Stability | experimental |
| Portability | GHC |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Reddit.Types.Account
Description
Synopsis
- newtype UserID = UserID Text
- data Account = Account {
- userID :: UserID
- username :: Username
- created :: UTCTime
- commentKarma :: Integer
- linkKarma :: Integer
- totalKarma :: Integer
- awarderKarma :: Maybe Integer
- awardeeKarma :: Maybe Integer
- isFriend :: Bool
- isGold :: Bool
- isMod :: Bool
- iconImg :: URL
- subreddit :: Subreddit
- numFriends :: Maybe Integer
- inboxCount :: Maybe Integer
- creddits :: Maybe Integer
- modHash :: Maybe Text
- over18 :: Maybe Bool
- hasMail :: Maybe Bool
- hasModMail :: Maybe Bool
- hasVerifiedEmail :: Maybe Bool
- hasGoldSubscription :: Maybe Bool
- goldExpiration :: Maybe UTCTime
- isSuspended :: Maybe Bool
- suspensionExpiration :: Maybe UTCTime
- data AccountSearchOpts = AccountSearchOpts {}
- data AccountSearchSort
- data Friend = Friend {}
- data FriendList
- data Karma = Karma {}
- data KarmaList
- data UserSummary = UserSummary {
- userID :: Maybe UserID
- name :: Username
- commentKarma :: Integer
- linkKarma :: Integer
- created :: UTCTime
- profilePicture :: URL
- profileColor :: Maybe RGBText
- profileOver18 :: Bool
- data UserSummaryList
- data UserModeratedList
- data Preferences = Preferences {
- defaultCommentSort :: ItemSort
- media :: MediaPreference
- mediaPreview :: MediaPreference
- minCommentScore :: Int
- minLinkScore :: Int
- numComments :: Int
- numSites :: Int
- lang :: Text
- acceptPMs :: AcceptPMs
- activityRelevantAds :: Bool
- allowClicktracking :: Bool
- beta :: Bool
- clickGadget :: Bool
- collapseReadMessages :: Bool
- compress :: Bool
- credditAutorenew :: Maybe Bool
- domainDetails :: Bool
- emailChatRequest :: Bool
- emailCommentReply :: Bool
- emailDigests :: Bool
- emailMessages :: Bool
- emailPostReply :: Bool
- emailPrivateMessage :: Bool
- emailUnsubscribeAll :: Bool
- emailUpvoteComment :: Bool
- emailUpvotePost :: Bool
- emailUserNewFollower :: Bool
- emailUsernameMention :: Bool
- enableDefaultThemes :: Bool
- feedRecommendationsEnabled :: Bool
- hideAds :: Bool
- hideDowns :: Bool
- hideFromRobots :: Bool
- hideUps :: Bool
- highlightControversial :: Bool
- highlightNewComments :: Bool
- ignoreSuggestedSort :: Bool
- inRedesignBeta :: Maybe Bool
- labelNSFW :: Bool
- legacySearch :: Bool
- liveOrangereds :: Bool
- markMessagesRead :: Bool
- monitorMentions :: Bool
- newWindow :: Bool
- nightMode :: Bool
- noProfanity :: Bool
- organic :: Maybe Bool
- over18 :: Bool
- privateFeeds :: Bool
- profileOptOut :: Bool
- publicVotes :: Bool
- research :: Bool
- searchIncludeOver18 :: Bool
- sendCrosspostMessages :: Bool
- sendWelcomeMessages :: Bool
- showFlair :: Bool
- showGoldExpiration :: Bool
- showLinkFlair :: Bool
- showLocationBasedRecommendations :: Bool
- showPresence :: Bool
- showPromote :: Maybe Bool
- showStylesheets :: Bool
- showTrending :: Bool
- showTwitter :: Bool
- storeVisits :: Bool
- thirdPartyDataPersonalizedAds :: Bool
- thirdPartyPersonalizedAds :: Bool
- thirdPartySiteDataPersonalizedAds :: Bool
- thirdPartySiteDataPersonalizedContent :: Bool
- threadedMessages :: Bool
- threadedModmail :: Bool
- topKarmaSubreddits :: Bool
- useGlobalDefaults :: Bool
- videoAutoplay :: Bool
- data MediaPreference
- data AcceptPMs
- usernameToDisplayName :: Username -> Text
Documentation
A unique, site-wide ID for an account
Account information. Most Maybe fields denote data that Reddit sets to null
if the requester does not own the account in question
Constructors
| Account | |
Fields
| |
Instances
data AccountSearchOpts Source #
Options for search Listings of Accounts
Constructors
| AccountSearchOpts | |
Fields
| |
Instances
data AccountSearchSort Source #
The item sort for Account searches
Constructors
| RelevantAccounts | |
| ActiveAccounts |
Instances
| Eq AccountSearchSort Source # | |
Defined in Network.Reddit.Types.Account Methods (==) :: AccountSearchSort -> AccountSearchSort -> Bool # (/=) :: AccountSearchSort -> AccountSearchSort -> Bool # | |
| Show AccountSearchSort Source # | |
Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> AccountSearchSort -> ShowS # show :: AccountSearchSort -> String # showList :: [AccountSearchSort] -> ShowS # | |
| Generic AccountSearchSort Source # | |
Defined in Network.Reddit.Types.Account Associated Types type Rep AccountSearchSort :: Type -> Type # Methods from :: AccountSearchSort -> Rep AccountSearchSort x # to :: Rep AccountSearchSort x -> AccountSearchSort # | |
| ToHttpApiData AccountSearchSort Source # | |
Defined in Network.Reddit.Types.Account Methods toUrlPiece :: AccountSearchSort -> Text # toEncodedUrlPiece :: AccountSearchSort -> Builder # toHeader :: AccountSearchSort -> ByteString # toQueryParam :: AccountSearchSort -> Text # | |
| type Rep AccountSearchSort Source # | |
Defined in Network.Reddit.Types.Account | |
A user's friend
Instances
| Eq Friend Source # | |
| Show Friend Source # | |
| Generic Friend Source # | |
| FromJSON Friend Source # | |
| type Rep Friend Source # | |
Defined in Network.Reddit.Types.Account type Rep Friend = D1 ('MetaData "Friend" "Network.Reddit.Types.Account" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Friend" 'PrefixI 'True) ((S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID)) :*: (S1 ('MetaSel ('Just "since") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "note") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
data FriendList Source #
Wrapper for parsing JSON objects listing Friends
Instances
| Show FriendList Source # | |
Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> FriendList -> ShowS # show :: FriendList -> String # showList :: [FriendList] -> ShowS # | |
| Generic FriendList Source # | |
Defined in Network.Reddit.Types.Account Associated Types type Rep FriendList :: Type -> Type # | |
| FromJSON FriendList Source # | |
Defined in Network.Reddit.Types.Account | |
| type Rep FriendList Source # | |
Defined in Network.Reddit.Types.Account type Rep FriendList = D1 ('MetaData "FriendList" "Network.Reddit.Types.Account" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "FriendList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq Friend)))) | |
Information about a user's karma
Constructors
| Karma | |
Fields | |
Instances
| Eq Karma Source # | |
| Show Karma Source # | |
| Generic Karma Source # | |
| FromJSON Karma Source # | |
| type Rep Karma Source # | |
Defined in Network.Reddit.Types.Account type Rep Karma = D1 ('MetaData "Karma" "Network.Reddit.Types.Account" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Karma" 'PrefixI 'True) (S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :*: (S1 ('MetaSel ('Just "commentKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "linkKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))) | |
Wrapper for parsing JSON array of Karma
data UserSummary Source #
A brief summary of a user, with significantly less information than a
Account
Constructors
| UserSummary | |
Fields
| |
Instances
data UserSummaryList Source #
Wrapper for parsing a JSON object of UserSummarys which has user IDs as
keys
Instances
| Show UserSummaryList Source # | |
Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> UserSummaryList -> ShowS # show :: UserSummaryList -> String # showList :: [UserSummaryList] -> ShowS # | |
| Generic UserSummaryList Source # | |
Defined in Network.Reddit.Types.Account Associated Types type Rep UserSummaryList :: Type -> Type # Methods from :: UserSummaryList -> Rep UserSummaryList x # to :: Rep UserSummaryList x -> UserSummaryList # | |
| FromJSON UserSummaryList Source # | |
Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser UserSummaryList # parseJSONList :: Value -> Parser [UserSummaryList] # | |
| type Rep UserSummaryList Source # | |
Defined in Network.Reddit.Types.Account type Rep UserSummaryList = D1 ('MetaData "UserSummaryList" "Network.Reddit.Types.Account" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "UserSummaryList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq UserSummary)))) | |
data UserModeratedList Source #
Wrapper for parsing the JSON returned when getting the moderated subreddits of a user
Instances
data Preferences Source #
User preferences
Constructors
| Preferences | |
Fields
| |
Instances
data MediaPreference Source #
How to deal with media previews and thumbnails in your Preferences
Constructors
| TurnOn | |
| TurnOff | |
| FollowSubreddit |
Instances
Policy for accepting private messages, for use in user Preferences
Constructors
| Everyone | |
| Whitelisted |
usernameToDisplayName :: Username -> Text Source #
Prefix the username with "u_"