Network.Reddit.Comment

Reading comments

getComments :: (MonadReddit m, Foldable t) => ItemOpts Comment -> t CommentID -> m (Seq Comment)

Get the Comments corresponding to a container of CommentIDs

getComment :: MonadReddit m => CommentID -> m Comment

Get information on a single CommentID. Throws an exception if no such Comment exists

withReplies :: MonadReddit m => ItemOpts a -> Comment -> m Comment

Update a Comment to include its ChildComments, returning the updated Comment. This will probably be necessary if the original Comment was obtained by getting a Username's or Subreddit's comments, etc...

loadMoreComments :: forall m. MonadReddit m => Maybe Word -> ItemOpts Comment -> SubmissionID -> MoreComments -> m (Seq ChildComment)

Transform MoreComments, loading the actual comments they refer to, up to the limit passed in (pass Nothing for no limit). If CommentIDs still remain from the original MoreComments, they will be returned in a new MoreComments inserted into the resulting sequence of ChildComments, along with an updated count

loadMoreCommentsDef :: MonadReddit m => SubmissionID -> MoreComments -> m (Seq ChildComment)

A version of loadMoreComments with default parameters for the limit (Nothing) and options (defaultItemOpts)

unsaveComment :: MonadReddit m => CommentID -> m ()

Unsave a comment

saveComment :: MonadReddit m => CommentID -> m ()

Save a comment

Creating, editing, and deleting

deleteComment :: MonadReddit m => CommentID -> m ()

Delete a comment that the currently authenticated user has authored, given its CommentID

editComment :: MonadReddit m => CommentID -> Body -> m Comment

Edit a comment given its CommentID, receving an updated Comment in response

replyToComment :: MonadReddit m => CommentID -> Body -> m Comment

Reply to a comment given its CommentID, returning the newly created Comment

getNewComments :: MonadReddit m => Maybe SubredditName -> Paginator CommentID Comment -> m (Listing CommentID Comment)

Get new Comments, either for the site as a whole or for a single subreddit, given its SubredditName

setCommentReplies :: MonadReddit m => Bool -> CommentID -> m ()

Enable/disable inbox replies for a comment

Voting

Note: According to Reddit's API rules:

votes must be cast by humans. That is, API clients proxying a human's action one-for-one are OK, but bots deciding how to vote on content or amplifying a human's vote are not. See the reddit rules for more details on what constitutes vote cheating.

upvoteComment :: MonadReddit m => CommentID -> m ()

Upvote a comment.

downvoteComment :: MonadReddit m => CommentID -> m ()

Downvote a comment.

unvoteComment :: MonadReddit m => CommentID -> m ()

Remove an existing vote on a comment.

reportComment :: MonadReddit m => Report -> CommentID -> m ()

Report a comment to the subreddit's mods

Types

data MoreComments

A link to load more children Comments

Constructors

MoreComments (Seq CommentID) Integer

Instances

Eq MoreComments

Defined in Network.Reddit.Types.Comment

Methods

(==) :: MoreComments -> MoreComments -> Bool

(/=) :: MoreComments -> MoreComments -> Bool

Show MoreComments

Defined in Network.Reddit.Types.Comment

Methods

showsPrec :: Int -> MoreComments -> ShowS

show :: MoreComments -> String

showList :: [MoreComments] -> ShowS

Generic MoreComments

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

Defined in Network.Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser MoreComments

parseJSONList :: Value -> Parser [MoreComments]

type Rep MoreComments

Defined in Network.Reddit.Types.Comment

type Rep MoreComments = D1 ('MetaData "MoreComments" "Network.Reddit.Types.Comment" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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

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

Eq ChildComment

Defined in Network.Reddit.Types.Comment

Methods

(==) :: ChildComment -> ChildComment -> Bool

(/=) :: ChildComment -> ChildComment -> Bool

Show ChildComment

Defined in Network.Reddit.Types.Comment

Methods

showsPrec :: Int -> ChildComment -> ShowS

show :: ChildComment -> String

showList :: [ChildComment] -> ShowS

Generic ChildComment

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

Defined in Network.Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser ChildComment

parseJSONList :: Value -> Parser [ChildComment]

type Rep ChildComment

Defined in Network.Reddit.Types.Comment

type Rep ChildComment = D1 ('MetaData "ChildComment" "Network.Reddit.Types.Comment" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 Comment

A Reddit comment

Constructors

Comment CommentID Username Body Body (Seq ChildComment) (Maybe Integer) (Maybe Integer) (Maybe Integer) UTCTime (Maybe UTCTime) SubredditName SubredditID Int (Maybe Bool) SubmissionID (Maybe URL) (Maybe Username) URL (Seq ItemReport) (Seq ItemReport) (Maybe Integer) (Maybe Distinction) Bool Bool

Instances

Eq Comment

Defined in Network.Reddit.Types.Comment

Methods

(==) :: Comment -> Comment -> Bool

(/=) :: Comment -> Comment -> Bool

Show Comment

Defined in Network.Reddit.Types.Comment

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

Generic Comment

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

Defined in Network.Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser Comment

parseJSONList :: Value -> Parser [Comment]

Paginable Comment

Defined in Network.Reddit.Types.Comment

Associated Types

type PaginateOptions Comment

type PaginateThing Comment

Methods

defaultOpts :: PaginateOptions Comment

getFullname :: Comment -> PaginateThing Comment

optsToForm :: PaginateOptions Comment -> Form

FromJSON (PostedItem Comment)

Defined in Network.Reddit.Types.Item

Methods

parseJSON :: Value -> Parser (PostedItem Comment)

parseJSONList :: Value -> Parser [PostedItem Comment]

type Rep Comment

Defined in Network.Reddit.Types.Comment

type Rep Comment = D1 ('MetaData "Comment" "Network.Reddit.Types.Comment" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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)))))))

type PaginateOptions Comment

Defined in Network.Reddit.Types.Comment

type PaginateOptions Comment = ItemOpts Comment

type PaginateThing Comment

Defined in Network.Reddit.Types.Comment

type PaginateThing Comment = CommentID

newtype CommentID

A Comment ID

Constructors

CommentID Text

Instances

Eq CommentID

Defined in Network.Reddit.Types.Comment

Methods

(==) :: CommentID -> CommentID -> Bool

(/=) :: CommentID -> CommentID -> Bool

Ord CommentID

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

Defined in Network.Reddit.Types.Comment

Methods

showsPrec :: Int -> CommentID -> ShowS

show :: CommentID -> String

showList :: [CommentID] -> ShowS

Generic CommentID

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

Defined in Network.Reddit.Types.Comment

Methods

parseJSON :: Value -> Parser CommentID

parseJSONList :: Value -> Parser [CommentID]

ToHttpApiData CommentID

Defined in Network.Reddit.Types.Comment

Methods

toUrlPiece :: CommentID -> Text

toEncodedUrlPiece :: CommentID -> Builder

toHeader :: CommentID -> ByteString

toQueryParam :: CommentID -> Text

Thing CommentID

Defined in Network.Reddit.Types.Comment

Methods

fullname :: CommentID -> Text

type Rep CommentID

Defined in Network.Reddit.Types.Comment

type Rep CommentID = D1 ('MetaData "CommentID" "Network.Reddit.Types.Comment" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'True) (C1 ('MetaCons "CommentID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))