Network.Reddit.Item

Actions with operate on Items, which can be either Comments or Submissions

Actions

delete :: MonadReddit m => ItemID -> m ()

Delete an Item

reply :: MonadReddit m => ItemID -> Body -> m Comment

Leave a comment in reply to an Item, which can be markdown-formatted. This will return the newly created Comment upon success

edit :: MonadReddit m => ItemID -> Body -> m Item

Edit some item, given its ItemID. The return value will be wrapped in an Item constructor, since it can be either a Comment or Submission

vote :: MonadReddit m => Vote -> ItemID -> m ()

Submit a vote. Be careful! Reddit views bot-based vote manipulation as a serious violation

report :: MonadReddit m => Report -> ItemID -> m ()

Report an item, which brings it to the attention of the subreddit moderators

save :: MonadReddit m => ItemID -> m ()

Save an item

unsave :: MonadReddit m => ItemID -> m ()

Unsave an item

award :: MonadReddit m => Award -> ItemID -> m AwardingsSummary

Grant an award to the author of an Item. See the docs for Award for information about the available options when awarding as well as mkAward to use defaults.

To grant a common award, such as gold, see the bundled pattern synonyms of AwardID. If you wish to anonymously gild an item without a message, see the gild action in this module, provided for convenience

gild :: MonadReddit m => ItemID -> m AwardingsSummary

Gild an item anonymously, without a message. To grant other types of awards to items, or to gild non-anonymously/with a message, see award

setInboxReplies :: MonadReddit m => Bool -> ItemID -> m ()

Enable or disable inbox replies for an item given its ItemID

getGildedItems :: MonadReddit m => SubredditName -> Paginator ItemID Item -> m (Listing ItemID Item)

Get a Listing of Items that have been gilded

Types

data AwardingsSummary

A summary of your Awardings, returned after you have awarded an item

Constructors

AwardingsSummary (Seq Awarding) (HashMap AwardID Integer) Integer

Instances

Eq AwardingsSummary

Defined in Network.Reddit.Types.Award

Methods

(==) :: AwardingsSummary -> AwardingsSummary -> Bool

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

Show AwardingsSummary

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> AwardingsSummary -> ShowS

show :: AwardingsSummary -> String

showList :: [AwardingsSummary] -> ShowS

Generic AwardingsSummary

Defined in Network.Reddit.Types.Award

Associated Types

type Rep AwardingsSummary :: Type -> Type

Methods

from :: AwardingsSummary -> Rep AwardingsSummary x

to :: Rep AwardingsSummary x -> AwardingsSummary

FromJSON AwardingsSummary

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser AwardingsSummary

parseJSONList :: Value -> Parser [AwardingsSummary]

type Rep AwardingsSummary

Defined in Network.Reddit.Types.Award

type Rep AwardingsSummary = D1 ('MetaData "AwardingsSummary" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "AwardingsSummary" 'PrefixI 'True) (S1 ('MetaSel ('Just "allAwardings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Awarding)) :*: (S1 ('MetaSel ('Just "gildings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap AwardID Integer)) :*: S1 ('MetaSel ('Just "coins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))

data Award

Options for awarding an item

Constructors

Award AwardID Bool (Maybe Body)

Instances

Eq Award

Defined in Network.Reddit.Types.Award

Methods

(==) :: Award -> Award -> Bool

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

Show Award

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> Award -> ShowS

show :: Award -> String

showList :: [Award] -> ShowS

Generic Award

Defined in Network.Reddit.Types.Award

Associated Types

type Rep Award :: Type -> Type

Methods

from :: Award -> Rep Award x

to :: Rep Award x -> Award

ToForm Award

Defined in Network.Reddit.Types.Award

Methods

toForm :: Award -> Form

type Rep Award

Defined in Network.Reddit.Types.Award

type Rep Award = D1 ('MetaData "Award" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Award" 'PrefixI 'True) (S1 ('MetaSel ('Just "awardID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AwardID) :*: (S1 ('MetaSel ('Just "isAnonymous") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)))))

newtype AwardID

The ID for an award, which users can grant each other. If you want to create a new AwardID, see the bundled pattern synonyms for this type, which include various common awards. Also see "doc/awards.org" in this repository for a list of awards and their IDs.

Note: Most newer awards are composed of a UUID identifier and an "award_" prefix. If you construct this type directly, you should omit the prefix, which will be added for you when making API requests

Constructors

AwardID Text

Bundled Patterns

pattern Ternion :: AwardID

pattern Argentium :: AwardID

pattern Platinum :: AwardID

pattern Gold :: AwardID

pattern Silver :: AwardID

Instances

Eq AwardID

Defined in Network.Reddit.Types.Award

Methods

(==) :: AwardID -> AwardID -> Bool

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

Show AwardID

Defined in Network.Reddit.Types.Award

Methods

showsPrec :: Int -> AwardID -> ShowS

show :: AwardID -> String

showList :: [AwardID] -> ShowS

Generic AwardID

Defined in Network.Reddit.Types.Award

Associated Types

type Rep AwardID :: Type -> Type

Methods

from :: AwardID -> Rep AwardID x

to :: Rep AwardID x -> AwardID

Hashable AwardID

Defined in Network.Reddit.Types.Award

Methods

hashWithSalt :: Int -> AwardID -> Int

hash :: AwardID -> Int

FromJSON AwardID

Defined in Network.Reddit.Types.Award

Methods

parseJSON :: Value -> Parser AwardID

parseJSONList :: Value -> Parser [AwardID]

FromJSONKey AwardID

Defined in Network.Reddit.Types.Award

Methods

fromJSONKey :: FromJSONKeyFunction AwardID

fromJSONKeyList :: FromJSONKeyFunction [AwardID]

ToHttpApiData AwardID

Defined in Network.Reddit.Types.Award

Methods

toUrlPiece :: AwardID -> Text

toEncodedUrlPiece :: AwardID -> Builder

toHeader :: AwardID -> ByteString

toQueryParam :: AwardID -> Text

type Rep AwardID

Defined in Network.Reddit.Types.Award

type Rep AwardID = D1 ('MetaData "AwardID" "Network.Reddit.Types.Award" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "AwardID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkAward :: AwardID -> Award

Create a new anonymous Awarding without a message, given an AwardID

data Report

The reason for issuing a report. The length of the contained text must be <= 100 characters

Instances

Eq Report

Defined in Network.Reddit.Types.Item

Methods

(==) :: Report -> Report -> Bool

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

Show Report

Defined in Network.Reddit.Types.Item

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

Generic Report

Defined in Network.Reddit.Types.Item

Associated Types

type Rep Report :: Type -> Type

Methods

from :: Report -> Rep Report x

to :: Rep Report x -> Report

ToHttpApiData Report

Defined in Network.Reddit.Types.Item

Methods

toUrlPiece :: Report -> Text

toEncodedUrlPiece :: Report -> Builder

toHeader :: Report -> ByteString

toQueryParam :: Report -> Text

type Rep Report

Defined in Network.Reddit.Types.Item

type Rep Report = D1 ('MetaData "Report" "Network.Reddit.Types.Item" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "Report" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Vote

The direction in which to vote

Constructors

Downvote

Unvote

Upvote

Instances

Eq Vote

Defined in Network.Reddit.Types.Item

Methods

(==) :: Vote -> Vote -> Bool

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

Ord Vote

Defined in Network.Reddit.Types.Item

Methods

compare :: Vote -> Vote -> Ordering

(<) :: Vote -> Vote -> Bool

(<=) :: Vote -> Vote -> Bool

(>) :: Vote -> Vote -> Bool

(>=) :: Vote -> Vote -> Bool

max :: Vote -> Vote -> Vote

min :: Vote -> Vote -> Vote

Show Vote

Defined in Network.Reddit.Types.Item

Methods

showsPrec :: Int -> Vote -> ShowS

show :: Vote -> String

showList :: [Vote] -> ShowS

Generic Vote

Defined in Network.Reddit.Types.Item

Associated Types

type Rep Vote :: Type -> Type

Methods

from :: Vote -> Rep Vote x

to :: Rep Vote x -> Vote

type Rep Vote

Defined in Network.Reddit.Types.Item

type Rep Vote = D1 ('MetaData "Vote" "Network.Reddit.Types.Item" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Downvote" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Unvote" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Upvote" 'PrefixI 'False) (U1 :: Type -> Type)))

data Item

Certain endpoints will return either Comments or a Submissions, or both

Constructors

CommentItem Comment

SubmissionItem Submission

Instances

Eq Item

Defined in Network.Reddit.Types.Item

Methods

(==) :: Item -> Item -> Bool

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

Show Item

Defined in Network.Reddit.Types.Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

Generic Item

Defined in Network.Reddit.Types.Item

Associated Types

type Rep Item :: Type -> Type

Methods

from :: Item -> Rep Item x

to :: Rep Item x -> Item

FromJSON Item

Defined in Network.Reddit.Types.Item

Methods

parseJSON :: Value -> Parser Item

parseJSONList :: Value -> Parser [Item]

Paginable Item

Defined in Network.Reddit.Types.Item

Associated Types

type PaginateOptions Item

type PaginateThing Item

Methods

defaultOpts :: PaginateOptions Item

getFullname :: Item -> PaginateThing Item

optsToForm :: PaginateOptions Item -> Form

FromJSON (PostedItem Item)

Defined in Network.Reddit.Types.Item

Methods

parseJSON :: Value -> Parser (PostedItem Item)

parseJSONList :: Value -> Parser [PostedItem Item]

type Rep Item

Defined in Network.Reddit.Types.Item

type Rep Item = D1 ('MetaData "Item" "Network.Reddit.Types.Item" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CommentItem" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Comment)) :+: C1 ('MetaCons "SubmissionItem" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Submission)))

type PaginateOptions Item

Defined in Network.Reddit.Types.Item

type PaginateOptions Item = ItemOpts

type PaginateThing Item

Defined in Network.Reddit.Types.Item

type PaginateThing Item = ItemID

data ItemID

Wraps either a CommentID or a SubmissionID. This is required to use Items with Paginators

Constructors

CommentItemID CommentID

SubmissionItemID SubmissionID

Instances

Eq ItemID

Defined in Network.Reddit.Types.Item

Methods

(==) :: ItemID -> ItemID -> Bool

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

Show ItemID

Defined in Network.Reddit.Types.Item

Methods

showsPrec :: Int -> ItemID -> ShowS

show :: ItemID -> String

showList :: [ItemID] -> ShowS

Generic ItemID

Defined in Network.Reddit.Types.Item

Associated Types

type Rep ItemID :: Type -> Type

Methods

from :: ItemID -> Rep ItemID x

to :: Rep ItemID x -> ItemID

FromJSON ItemID

Defined in Network.Reddit.Types.Item

Methods

parseJSON :: Value -> Parser ItemID

parseJSONList :: Value -> Parser [ItemID]

Thing ItemID

Defined in Network.Reddit.Types.Item

Methods

fullname :: ItemID -> Text

type Rep ItemID

Defined in Network.Reddit.Types.Item

type Rep ItemID = D1 ('MetaData "ItemID" "Network.Reddit.Types.Item" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CommentItemID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommentID)) :+: C1 ('MetaCons "SubmissionItemID" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionID)))

mkReport :: MonadThrow m => Text -> m Report

Smart constructor for Reports, which may be no longer than 100 characters in length