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

Description

Synopsis

data Comment = Comment {
- commentID :: CommentID
- author :: Username
- body :: Body
- bodyHTML :: Body
- replies :: Seq ChildComment
- score :: Maybe Integer
- ups :: Maybe Integer
- downs :: Maybe Integer
- created :: UTCTime
- edited :: Maybe UTCTime
- subreddit :: SubredditName
- subredditID :: SubredditID
- gilded :: Int
- scoreHidden :: Maybe Bool
- linkID :: SubmissionID
- linkURL :: Maybe URL
- linkAuthor :: Maybe Username
- permaLink :: URL
- userReports :: Seq ItemReport
- modReports :: Seq ItemReport
- numReports :: Maybe Integer
- distinguished :: Maybe Distinction
- isSubmitter :: Bool
- stickied :: Bool
- allAwardings :: Seq Awarding
}
newtype CommentID = CommentID Text
data MoreComments = MoreComments {
- childIDs :: Seq CommentID
- count :: Integer
}
data ChildComment
- = TopLevel Comment
- | More MoreComments
data WithChildren
data WithReplies
commentP :: Object -> Parser Comment
data LoadedChildren

Documentation

data Comment Source #

A Reddit comment

Constructors

Comment

Fields

commentID :: CommentID
author :: Username
body :: Body
bodyHTML :: Body
replies :: Seq ChildComment
This field will be empty unless the comment was obtained via withReplies
score :: Maybe Integer
ups :: Maybe Integer
downs :: Maybe Integer
created :: UTCTime
edited :: Maybe UTCTime
subreddit :: SubredditName
subredditID :: SubredditID
gilded :: Int
scoreHidden :: Maybe Bool
linkID :: SubmissionID
linkURL :: Maybe URL
linkAuthor :: Maybe Username
permaLink :: URL
userReports :: Seq ItemReport
modReports :: Seq ItemReport
numReports :: Maybe Integer
distinguished :: Maybe Distinction
isSubmitter :: Bool
Whether the author of the comment is also the submission author
stickied :: Bool
allAwardings :: Seq Awarding

Instances

Instances details

Eq Comment Source #
Instance details Defined in Network.Reddit.Types.Comment Methods (==) :: Comment -> Comment -> Bool # (/=) :: Comment -> Comment -> Bool #
Show Comment Source #
Instance details Defined in Network.Reddit.Types.Comment Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #
Generic Comment Source #
Instance details Defined in Network.Reddit.Types.Comment Associated Types type Rep Comment :: Type -> Type # Methods from :: Comment -> Rep Comment x # to :: Rep Comment x -> Comment #
FromJSON Comment Source #
Instance details Defined in Network.Reddit.Types.Comment Methods parseJSON :: Value -> Parser Comment # parseJSONList :: Value -> Parser [Comment] #
Paginable Comment Source #
Instance details Defined in Network.Reddit.Types.Comment Associated Types type PaginateOptions Comment Source # type PaginateThing Comment Source # Methods defaultOpts :: PaginateOptions Comment Source # getFullname :: Comment -> PaginateThing Comment Source # optsToForm :: PaginateOptions Comment -> Form Source #
FromJSON (PostedItem Comment) Source #
Instance details Defined in Network.Reddit.Types.Item Methods parseJSON :: Value -> Parser (PostedItem Comment) # parseJSONList :: Value -> Parser [PostedItem Comment] #
type Rep Comment Source #
Instance details Defined in Network.Reddit.Types.Comment type Rep Comment = D1 ('MetaData "Comment" "Network.Reddit.Types.Comment" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Comment" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "commentID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommentID) :: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))) :: (S1 ('MetaSel ('Just "bodyHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: (S1 ('MetaSel ('Just "replies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ChildComment)) :: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "ups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "downs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))) :: (S1 ('MetaSel ('Just "edited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :: (S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :: S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditID))))) :: (((S1 ('MetaSel ('Just "gilded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "scoreHidden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "linkID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionID))) :: (S1 ('MetaSel ('Just "linkURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)) :: (S1 ('MetaSel ('Just "linkAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Username)) :: S1 ('MetaSel ('Just "permaLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL)))) :: ((S1 ('MetaSel ('Just "userReports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ItemReport)) :: (S1 ('MetaSel ('Just "modReports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ItemReport)) :: S1 ('MetaSel ('Just "numReports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "distinguished") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Distinction)) :: S1 ('MetaSel ('Just "isSubmitter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "stickied") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "allAwardings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Awarding))))))))
type PaginateOptions Comment Source #
Instance details Defined in Network.Reddit.Types.Comment type PaginateOptions Comment = ItemOpts
type PaginateThing Comment Source #
Instance details Defined in Network.Reddit.Types.Comment type PaginateThing Comment = CommentID

newtype CommentID Source #

A Comment ID

Constructors

CommentID Text

Instances

Instances details

Eq CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Methods (==) :: CommentID -> CommentID -> Bool # (/=) :: CommentID -> CommentID -> Bool #
Ord CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Methods compare :: CommentID -> CommentID -> Ordering # (<) :: CommentID -> CommentID -> Bool # (<=) :: CommentID -> CommentID -> Bool # (>) :: CommentID -> CommentID -> Bool # (>=) :: CommentID -> CommentID -> Bool # max :: CommentID -> CommentID -> CommentID # min :: CommentID -> CommentID -> CommentID #
Show CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Methods showsPrec :: Int -> CommentID -> ShowS # show :: CommentID -> String # showList :: [CommentID] -> ShowS #
Generic CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Associated Types type Rep CommentID :: Type -> Type # Methods from :: CommentID -> Rep CommentID x # to :: Rep CommentID x -> CommentID #
FromJSON CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Methods parseJSON :: Value -> Parser CommentID # parseJSONList :: Value -> Parser [CommentID] #
ToHttpApiData CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Methods toUrlPiece :: CommentID -> Text # toEncodedUrlPiece :: CommentID -> Builder # toHeader :: CommentID -> ByteString # toQueryParam :: CommentID -> Text #
Thing CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment Methods fullname :: CommentID -> Text Source #
type Rep CommentID Source #
Instance details Defined in Network.Reddit.Types.Comment type Rep CommentID = D1 ('MetaData "CommentID" "Network.Reddit.Types.Comment" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "CommentID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data MoreComments Source #

A link to load more children Comments

Constructors

MoreComments
Fields childIDs :: Seq CommentID count :: Integer The number of "collapsed" comments that can be loaded

Instances

Instances details

Eq MoreComments Source #
Instance details Defined in Network.Reddit.Types.Comment Methods (==) :: MoreComments -> MoreComments -> Bool # (/=) :: MoreComments -> MoreComments -> Bool #
Show MoreComments Source #
Instance details Defined in Network.Reddit.Types.Comment Methods showsPrec :: Int -> MoreComments -> ShowS # show :: MoreComments -> String # showList :: [MoreComments] -> ShowS #
Generic MoreComments Source #
Instance details Defined in Network.Reddit.Types.Comment Associated Types type Rep MoreComments :: Type -> Type # Methods from :: MoreComments -> Rep MoreComments x # to :: Rep MoreComments x -> MoreComments #
FromJSON MoreComments Source #
Instance details Defined in Network.Reddit.Types.Comment Methods parseJSON :: Value -> Parser MoreComments # parseJSONList :: Value -> Parser [MoreComments] #
type Rep MoreComments Source #
Instance details Defined in Network.Reddit.Types.Comment type Rep MoreComments = D1 ('MetaData "MoreComments" "Network.Reddit.Types.Comment" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "MoreComments" 'PrefixI 'True) (S1 ('MetaSel ('Just "childIDs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq CommentID)) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))

data ChildComment Source #

Represents a comments on a submission or replies to a comment, which can be actual Comments, or a list of children corresponding to "load more" or "continue this thread" links on Reddit's UI

Constructors

TopLevel Comment
More MoreComments

Instances

Instances details

Eq ChildComment Source #
Instance details Defined in Network.Reddit.Types.Comment Methods (==) :: ChildComment -> ChildComment -> Bool # (/=) :: ChildComment -> ChildComment -> Bool #
Show ChildComment Source #
Instance details Defined in Network.Reddit.Types.Comment Methods showsPrec :: Int -> ChildComment -> ShowS # show :: ChildComment -> String # showList :: [ChildComment] -> ShowS #
Generic ChildComment Source #
Instance details Defined in Network.Reddit.Types.Comment Associated Types type Rep ChildComment :: Type -> Type # Methods from :: ChildComment -> Rep ChildComment x # to :: Rep ChildComment x -> ChildComment #
FromJSON ChildComment Source #
Instance details Defined in Network.Reddit.Types.Comment Methods parseJSON :: Value -> Parser ChildComment # parseJSONList :: Value -> Parser [ChildComment] #
type Rep ChildComment Source #
Instance details Defined in Network.Reddit.Types.Comment type Rep ChildComment = D1 ('MetaData "ChildComment" "Network.Reddit.Types.Comment" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "TopLevel" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Comment)) :+: C1 ('MetaCons "More" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MoreComments)))

data WithChildren Source #

This wraps the ChildComments of a Submission

Instances

Instances details

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

data WithReplies Source #

This wraps a Comment which has been fetched with its ChildComments

Instances

Instances details

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

commentP :: Object -> Parser Comment Source #

Parse a Comment

data LoadedChildren Source #

Instances

Instances details

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