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.User

Contents

Actions
User Listings and summaries
Types

Description

Actions related to users, excluding the currently logged-in one. For actions on the current account, see Network.Reddit.Me

Synopsis

isUsernameAvailable :: MonadReddit m => Username -> m Bool
getUser :: MonadReddit m => Username -> m Account
getUserTrophies :: MonadReddit m => Username -> m (Seq Trophy)
getUserComments :: MonadReddit m => Username -> Paginator CommentID Comment -> m (Listing CommentID Comment)
getUserSubmissions :: MonadReddit m => Username -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getUserUpvoted :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item)
getUserDownvoted :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item)
getUserHidden :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item)
getUserOverview :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item)
getUserGilded :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item)
getUserSaved :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item)
getUserMultireddits :: MonadReddit m => Username -> m (Seq Multireddit)
getNewUsers :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
getPopularUsers :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
searchUsers :: MonadReddit m => Text -> Paginator UserID Account -> m (Listing UserID Account)
getUserSummaries :: (MonadReddit m, Foldable t) => t UserID -> m (Seq UserSummary)
getUserSummary :: MonadReddit m => UserID -> m UserSummary
data AcceptPMs
- = Everyone
- | Whitelisted
data MediaPreference
- = TurnOn
- | TurnOff
- | FollowSubreddit
data Preferences = Preferences ItemSort MediaPreference MediaPreference Int Int Int Int Text AcceptPMs Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool
data UserSummary = UserSummary (Maybe UserID) Username Integer Integer UTCTime URL (Maybe RGBText) Bool
data Trophy = Trophy Name (Maybe Text) (Maybe Text) (Maybe Body) (Maybe UTCTime)
data Karma = Karma SubredditName Integer Integer
data Friend = Friend Username UserID UTCTime (Maybe Text)
data AccountSearchSort
- = RelevantAccounts
- | ActiveAccounts
data AccountSearchOpts = AccountSearchOpts AccountSearchSort (Maybe Bool) (Maybe Text)
data Account = Account UserID Username UTCTime Int Bool Bool Int (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
newtype UserID = UserID Text
data Username
mkUsername :: MonadThrow m => Text -> m Username

Actions

isUsernameAvailable :: MonadReddit m => Username -> m Bool Source #

Check if a Username is available for use

getUser :: MonadReddit m => Username -> m Account Source #

Get information about another user

getUserTrophies :: MonadReddit m => Username -> m (Seq Trophy) Source #

Get a user's Trophys

getUserComments :: MonadReddit m => Username -> Paginator CommentID Comment -> m (Listing CommentID Comment) Source #

Get a Listing of a user's Comments

getUserSubmissions :: MonadReddit m => Username -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get a Listing of a user's Submissions

getUserUpvoted :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item) Source #

Get Items that a user has upvoted. You must be authorized to access this, or an exception will be raised

getUserDownvoted :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item) Source #

Get Items that a user has upvoted. You must be authorized to access this, or an exception will be raised

getUserHidden :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item) Source #

Get Items that a user has hidden. You must be authorized to access this, or an exception will be raised

getUserOverview :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item) Source #

Get an overview of a user's Comments and Submissions

getUserGilded :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item) Source #

Get the Items that a user has gilded

getUserSaved :: MonadReddit m => Username -> Paginator ItemID Item -> m (Listing ItemID Item) Source #

Get the Items that a user has saved. You must be authorized to access this, or an exception will be raised

getUserMultireddits :: MonadReddit m => Username -> m (Seq Multireddit) Source #

Get the public Multireddits belonging to the given user

User `Listing`s and summaries

These actions return Listings for special user subreddits, user accounts, or UserSummarys for existing user IDs

getNewUsers :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit) Source #

Get a Listing of special user subreddits, sorted on creation date (newest first)

Get a Listing of special user subreddits, sorted on popularity

searchUsers :: MonadReddit m => Text -> Paginator UserID Account -> m (Listing UserID Account) Source #

Get a Listing of user profiles whose titles and descriptions which match the given query

getUserSummaries :: (MonadReddit m, Foldable t) => t UserID -> m (Seq UserSummary) Source #

Get a brief UserSummary for each valid UserID. Note that Reddit silently ignores invalid IDs, so the output may be shorted than the input container

getUserSummary :: MonadReddit m => UserID -> m UserSummary Source #

Get the UserSummary for a single user ID

Types

data AcceptPMs Source #

Policy for accepting private messages, for use in user Preferences

Constructors

Everyone
Whitelisted

Instances

Instances details

Eq AcceptPMs Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: AcceptPMs -> AcceptPMs -> Bool # (/=) :: AcceptPMs -> AcceptPMs -> Bool #
Show AcceptPMs Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> AcceptPMs -> ShowS # show :: AcceptPMs -> String # showList :: [AcceptPMs] -> ShowS #
Generic AcceptPMs Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep AcceptPMs :: Type -> Type # Methods from :: AcceptPMs -> Rep AcceptPMs x # to :: Rep AcceptPMs x -> AcceptPMs #
ToJSON AcceptPMs Source #
Instance details Defined in Network.Reddit.Types.Account Methods toJSON :: AcceptPMs -> Value # toEncoding :: AcceptPMs -> Encoding # toJSONList :: [AcceptPMs] -> Value # toEncodingList :: [AcceptPMs] -> Encoding #
FromJSON AcceptPMs Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser AcceptPMs # parseJSONList :: Value -> Parser [AcceptPMs] #
type Rep AcceptPMs Source #
Instance details Defined in Network.Reddit.Types.Account type Rep AcceptPMs = D1 ('MetaData "AcceptPMs" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Everyone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Whitelisted" 'PrefixI 'False) (U1 :: Type -> Type))

data MediaPreference Source #

How to deal with media previews and thumbnails in your Preferences

Constructors

TurnOn
TurnOff
FollowSubreddit

Instances

Instances details

Eq MediaPreference Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: MediaPreference -> MediaPreference -> Bool # (/=) :: MediaPreference -> MediaPreference -> Bool #
Show MediaPreference Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> MediaPreference -> ShowS # show :: MediaPreference -> String # showList :: [MediaPreference] -> ShowS #
Generic MediaPreference Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep MediaPreference :: Type -> Type # Methods from :: MediaPreference -> Rep MediaPreference x # to :: Rep MediaPreference x -> MediaPreference #
ToJSON MediaPreference Source #
Instance details Defined in Network.Reddit.Types.Account Methods toJSON :: MediaPreference -> Value # toEncoding :: MediaPreference -> Encoding # toJSONList :: [MediaPreference] -> Value # toEncodingList :: [MediaPreference] -> Encoding #
FromJSON MediaPreference Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser MediaPreference # parseJSONList :: Value -> Parser [MediaPreference] #
type Rep MediaPreference Source #
Instance details Defined in Network.Reddit.Types.Account type Rep MediaPreference = D1 ('MetaData "MediaPreference" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "TurnOn" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TurnOff" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FollowSubreddit" 'PrefixI 'False) (U1 :: Type -> Type)))

data Preferences Source #

User preferences

Constructors

Preferences ItemSort MediaPreference MediaPreference Int Int Int Int Text AcceptPMs Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool

Instances

Instances details

Eq Preferences Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: Preferences -> Preferences -> Bool # (/=) :: Preferences -> Preferences -> Bool #
Show Preferences Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> Preferences -> ShowS # show :: Preferences -> String # showList :: [Preferences] -> ShowS #
Generic Preferences Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep Preferences :: Type -> Type # Methods from :: Preferences -> Rep Preferences x # to :: Rep Preferences x -> Preferences #
ToJSON Preferences Source #
Instance details Defined in Network.Reddit.Types.Account Methods toJSON :: Preferences -> Value # toEncoding :: Preferences -> Encoding # toJSONList :: [Preferences] -> Value # toEncodingList :: [Preferences] -> Encoding #
FromJSON Preferences Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser Preferences # parseJSONList :: Value -> Parser [Preferences] #
type Rep Preferences Source #
Instance details Defined in Network.Reddit.Types.Account type Rep Preferences = D1 ('MetaData "Preferences" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Preferences" 'PrefixI 'True) ((((((S1 ('MetaSel ('Just "defaultCommentSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ItemSort) :: S1 ('MetaSel ('Just "media") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MediaPreference)) :: (S1 ('MetaSel ('Just "mediaPreview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MediaPreference) :: S1 ('MetaSel ('Just "minCommentScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :: ((S1 ('MetaSel ('Just "minLinkScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "numComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "numSites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "lang") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "acceptPMs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AcceptPMs))))) :: (((S1 ('MetaSel ('Just "activityRelevantAds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "allowClicktracking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "beta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "clickGadget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "collapseReadMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "compress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "credditAutorenew") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "domainDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "emailChatRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))) :: ((((S1 ('MetaSel ('Just "emailCommentReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "emailDigests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "emailMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "emailPostReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "emailPrivateMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "emailUnsubscribeAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "emailUpvoteComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "emailUpvotePost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "emailUserNewFollower") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))) :: (((S1 ('MetaSel ('Just "emailUsernameMention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "enableDefaultThemes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "feedRecommendationsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "hideAds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "hideDowns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :: ((S1 ('MetaSel ('Just "hideFromRobots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "hideUps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "highlightControversial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "highlightNewComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "ignoreSuggestedSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))) :: (((((S1 ('MetaSel ('Just "inRedesignBeta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "labelNSFW") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "legacySearch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "liveOrangereds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "markMessagesRead") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "monitorMentions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "newWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "nightMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "noProfanity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))) :: (((S1 ('MetaSel ('Just "organic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "privateFeeds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "profileOptOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "publicVotes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "research") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "searchIncludeOver18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "sendCrosspostMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "sendWelcomeMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))) :: ((((S1 ('MetaSel ('Just "showFlair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "showGoldExpiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "showLinkFlair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "showLocationBasedRecommendations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "showPresence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "showPromote") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "showStylesheets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "showTrending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "showTwitter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))) :: (((S1 ('MetaSel ('Just "storeVisits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "thirdPartyDataPersonalizedAds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "thirdPartyPersonalizedAds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "thirdPartySiteDataPersonalizedAds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "thirdPartySiteDataPersonalizedContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :: ((S1 ('MetaSel ('Just "threadedMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "threadedModmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "topKarmaSubreddits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "useGlobalDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "videoAutoplay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))))))

data UserSummary Source #

A brief summary of a user, with significantly less information than a Account

Constructors

UserSummary (Maybe UserID) Username Integer Integer UTCTime URL (Maybe RGBText) Bool

Instances

Instances details

Eq UserSummary Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: UserSummary -> UserSummary -> Bool # (/=) :: UserSummary -> UserSummary -> Bool #
Show UserSummary Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> UserSummary -> ShowS # show :: UserSummary -> String # showList :: [UserSummary] -> ShowS #
Generic UserSummary Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep UserSummary :: Type -> Type # Methods from :: UserSummary -> Rep UserSummary x # to :: Rep UserSummary x -> UserSummary #
FromJSON UserSummary Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser UserSummary # parseJSONList :: Value -> Parser [UserSummary] #
type Rep UserSummary Source #
Instance details Defined in Network.Reddit.Types.Account type Rep UserSummary = D1 ('MetaData "UserSummary" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "UserSummary" 'PrefixI 'True) (((S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserID)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username)) :: (S1 ('MetaSel ('Just "commentKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: S1 ('MetaSel ('Just "linkKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) :: ((S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "profilePicture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL)) :: (S1 ('MetaSel ('Just "profileColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)) :*: S1 ('MetaSel ('Just "profileOver18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

data Trophy Source #

A Reddit award, such as the "one-year club"

Constructors

Trophy Name (Maybe Text) (Maybe Text) (Maybe Body) (Maybe UTCTime)

Instances

Instances details

Eq Trophy Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: Trophy -> Trophy -> Bool # (/=) :: Trophy -> Trophy -> Bool #
Show Trophy Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> Trophy -> ShowS # show :: Trophy -> String # showList :: [Trophy] -> ShowS #
Generic Trophy Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep Trophy :: Type -> Type # Methods from :: Trophy -> Rep Trophy x # to :: Rep Trophy x -> Trophy #
FromJSON Trophy Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser Trophy # parseJSONList :: Value -> Parser [Trophy] #
type Rep Trophy Source #
Instance details Defined in Network.Reddit.Types.Account type Rep Trophy = D1 ('MetaData "Trophy" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Trophy" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :: S1 ('MetaSel ('Just "trophyID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "awardID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: S1 ('MetaSel ('Just "grantedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime))))))

data Karma Source #

Information about a user's karma

Constructors

Karma SubredditName Integer Integer

Instances

Instances details

Eq Karma Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: Karma -> Karma -> Bool # (/=) :: Karma -> Karma -> Bool #
Show Karma Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> Karma -> ShowS # show :: Karma -> String # showList :: [Karma] -> ShowS #
Generic Karma Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep Karma :: Type -> Type # Methods from :: Karma -> Rep Karma x # to :: Rep Karma x -> Karma #
FromJSON Karma Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser Karma # parseJSONList :: Value -> Parser [Karma] #
type Rep Karma Source #
Instance details Defined in Network.Reddit.Types.Account type Rep Karma = D1 ('MetaData "Karma" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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))))

data Friend Source #

A user's friend

Constructors

Friend Username UserID UTCTime (Maybe Text)

Instances

Instances details

Eq Friend Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: Friend -> Friend -> Bool # (/=) :: Friend -> Friend -> Bool #
Show Friend Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> Friend -> ShowS # show :: Friend -> String # showList :: [Friend] -> ShowS #
Generic Friend Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep Friend :: Type -> Type # Methods from :: Friend -> Rep Friend x # to :: Rep Friend x -> Friend #
FromJSON Friend Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser Friend # parseJSONList :: Value -> Parser [Friend] #
type Rep Friend Source #
Instance details Defined in Network.Reddit.Types.Account type Rep Friend = D1 ('MetaData "Friend" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 AccountSearchSort Source #

The item sort for Account searches

Constructors

RelevantAccounts
ActiveAccounts

Instances

Instances details

Eq AccountSearchSort Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: AccountSearchSort -> AccountSearchSort -> Bool # (/=) :: AccountSearchSort -> AccountSearchSort -> Bool #
Show AccountSearchSort Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> AccountSearchSort -> ShowS # show :: AccountSearchSort -> String # showList :: [AccountSearchSort] -> ShowS #
Generic AccountSearchSort Source #
Instance details 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 #
Instance details Defined in Network.Reddit.Types.Account Methods toUrlPiece :: AccountSearchSort -> Text # toEncodedUrlPiece :: AccountSearchSort -> Builder # toHeader :: AccountSearchSort -> ByteString # toQueryParam :: AccountSearchSort -> Text #
type Rep AccountSearchSort Source #
Instance details Defined in Network.Reddit.Types.Account type Rep AccountSearchSort = D1 ('MetaData "AccountSearchSort" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "RelevantAccounts" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ActiveAccounts" 'PrefixI 'False) (U1 :: Type -> Type))

data AccountSearchOpts Source #

Options for search Listings of Accounts

Constructors

AccountSearchOpts AccountSearchSort (Maybe Bool) (Maybe Text)

Instances

Instances details

Eq AccountSearchOpts Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: AccountSearchOpts -> AccountSearchOpts -> Bool # (/=) :: AccountSearchOpts -> AccountSearchOpts -> Bool #
Show AccountSearchOpts Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> AccountSearchOpts -> ShowS # show :: AccountSearchOpts -> String # showList :: [AccountSearchOpts] -> ShowS #
Generic AccountSearchOpts Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep AccountSearchOpts :: Type -> Type # Methods from :: AccountSearchOpts -> Rep AccountSearchOpts x # to :: Rep AccountSearchOpts x -> AccountSearchOpts #
ToForm AccountSearchOpts Source #
Instance details Defined in Network.Reddit.Types.Account Methods toForm :: AccountSearchOpts -> Form #
type Rep AccountSearchOpts Source #
Instance details Defined in Network.Reddit.Types.Account type Rep AccountSearchOpts = D1 ('MetaData "AccountSearchOpts" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "AccountSearchOpts" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccountSearchSort) :: (S1 ('MetaSel ('Just "typeaheadActive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "searchQueryID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

data Account Source #

Account information. Maybe fields denote data that Reddit sets to null if the requester does not own the account in question. Note that this does not include all of the possible fields that may be present in Reddit's response - which are quite numerous in total and poorly documented

Constructors

Account UserID Username UTCTime Int Bool Bool Int (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)

Instances

Instances details

Show Account Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
Generic Account Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep Account :: Type -> Type # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
FromJSON Account Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #
Paginable Account Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type PaginateOptions Account Source # type PaginateThing Account Source # Methods defaultOpts :: PaginateOptions Account Source # getFullname :: Account -> PaginateThing Account Source # optsToForm :: PaginateOptions Account -> Form Source #
type Rep Account Source #
Instance details Defined in Network.Reddit.Types.Account type Rep Account = D1 ('MetaData "Account" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Account" 'PrefixI 'True) (((S1 ('MetaSel ('Just "userID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserID) :: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))) :: (S1 ('MetaSel ('Just "commentKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "isGold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "isMod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))) :: ((S1 ('MetaSel ('Just "linkKarma") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "inboxCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "modHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "hasMail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "hasModMail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "hasVerifiedEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))
type PaginateOptions Account Source #
Instance details Defined in Network.Reddit.Types.Account type PaginateOptions Account = AccountSearchOpts
type PaginateThing Account Source #
Instance details Defined in Network.Reddit.Types.Account type PaginateThing Account = UserID

newtype UserID Source #

A unique, site-wide ID for an account

Constructors

UserID Text

Instances

Instances details

Eq UserID Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: UserID -> UserID -> Bool # (/=) :: UserID -> UserID -> Bool #
Show UserID Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> UserID -> ShowS # show :: UserID -> String # showList :: [UserID] -> ShowS #
Generic UserID Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep UserID :: Type -> Type # Methods from :: UserID -> Rep UserID x # to :: Rep UserID x -> UserID #
FromJSON UserID Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser UserID # parseJSONList :: Value -> Parser [UserID] #
Thing UserID Source #
Instance details Defined in Network.Reddit.Types.Account Methods fullname :: UserID -> Text Source #
type Rep UserID Source #
Instance details Defined in Network.Reddit.Types.Account type Rep UserID = D1 ('MetaData "UserID" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "UserID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Username Source #

Reddit username

Instances

Instances details

Eq Username Source #
Instance details Defined in Network.Reddit.Types.Account Methods (==) :: Username -> Username -> Bool # (/=) :: Username -> Username -> Bool #
Show Username Source #
Instance details Defined in Network.Reddit.Types.Account Methods showsPrec :: Int -> Username -> ShowS # show :: Username -> String # showList :: [Username] -> ShowS #
Generic Username Source #
Instance details Defined in Network.Reddit.Types.Account Associated Types type Rep Username :: Type -> Type # Methods from :: Username -> Rep Username x # to :: Rep Username x -> Username #
ToJSON Username Source #
Instance details Defined in Network.Reddit.Types.Account Methods toJSON :: Username -> Value # toEncoding :: Username -> Encoding # toJSONList :: [Username] -> Value # toEncodingList :: [Username] -> Encoding #
FromJSON Username Source #
Instance details Defined in Network.Reddit.Types.Account Methods parseJSON :: Value -> Parser Username # parseJSONList :: Value -> Parser [Username] #
ToHttpApiData Username Source #
Instance details Defined in Network.Reddit.Types.Account Methods toUrlPiece :: Username -> Text # toEncodedUrlPiece :: Username -> Builder # toHeader :: Username -> ByteString # toQueryParam :: Username -> Text #
type Rep Username Source #
Instance details Defined in Network.Reddit.Types.Account type Rep Username = D1 ('MetaData "Username" "Network.Reddit.Types.Account" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "Username" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkUsername :: MonadThrow m => Text -> m Username Source #

Smart constructor for Username, which must be between 3 and 20 chars, and may only include upper/lowercase alphanumeric chars, underscores, or hyphens

Actions

User Listings and summaries

Types

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

User `Listing`s and summaries