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

Contents

Collections
Creating submissions
Search

Description

Synopsis

data Submission = Submission {
- submissionID :: SubmissionID
- title :: Title
- author :: Username
- content :: SubmissionContent
- subreddit :: SubredditName
- created :: UTCTime
- edited :: Maybe UTCTime
- permalink :: URL
- domain :: Domain
- numComments :: Integer
- score :: Integer
- ups :: Maybe Integer
- downs :: Maybe Integer
- upvoteRatio :: Maybe Rational
- gilded :: Integer
- userReports :: Seq ItemReport
- modReports :: Seq ItemReport
- numReports :: Maybe Integer
- distinguished :: Maybe Distinction
- isOC :: Bool
- clicked :: Bool
- over18 :: Bool
- locked :: Bool
- spoiler :: Bool
- pollData :: Maybe PollData
- allAwardings :: Seq Awarding
}
newtype SubmissionID = SubmissionID Text
data SubmissionContent
- = SelfText Body Body
- | ExternalLink URL
- | EmptySubmission
submissionP :: Object -> Parser Submission
data PollData = PollData {
- options :: Seq PollOption
- totalVoteCount :: Integer
- votingEnds :: UTCTime
- userSelection :: Maybe PollOptionID
}
data PollOption = PollOption {
- pollOptionID :: PollOptionID
- text :: Body
- voteCount :: Integer
}
type PollOptionID = Text
data Collection = Collection {
- collectionID :: CollectionID
- author :: Username
- title :: Title
- subredditID :: SubredditID
- description :: Body
- permalink :: URL
- created :: UTCTime
- lastUpdated :: UTCTime
- linkIDs :: Seq SubmissionID
- sortedLinks :: Seq Submission
- layout :: Maybe CollectionLayout
}
data CollectionLayout
- = Gallery
- | Timeline
type CollectionID = Text
data NewCollection = NewCollection {
- title :: Title
- description :: Body
- subredditID :: SubredditID
- layout :: Maybe CollectionLayout
}
data SubmissionOptions = SubmissionOptions {
- title :: Title
- subreddit :: SubredditName
- nsfw :: Bool
- sendreplies :: Bool
- resubmit :: Bool
- spoiler :: Bool
- collectionID :: Maybe CollectionID
- flairID :: Maybe FlairID
- flairText :: Maybe FlairText
}
mkSubmissionOptions :: SubredditName -> Title -> SubmissionOptions
data NewSubmission
- = SelfPost Body SubmissionOptions
- | WithInlineMedia Fancypants SubmissionOptions
- | Link URL SubmissionOptions
- | ImagePost UploadURL SubmissionOptions
- | VideoPost UploadURL UploadURL Bool SubmissionOptions
data S3UploadLease = S3UploadLease {
- action :: URL
- fields :: HashMap Text Text
- key :: Text
- websocketURL :: URL
- assetID :: UploadURL
}
data UploadType
- = SelfPostUpload
- | LinkUpload
- | GalleryUpload
data UploadResult = UploadResult {
- resultType :: Text
- redirectURL :: URL
}
data CrosspostOptions = CrosspostOptions {
- subreddit :: SubredditName
- title :: Title
- nsfw :: Bool
- sendreplies :: Bool
- spoiler :: Bool
- flairID :: Maybe FlairID
- flairText :: Maybe FlairText
}
mkCrosspostOptions :: SubredditName -> Title -> CrosspostOptions
data PostedCrosspost
data Poll t = Poll {
- options :: t Text
- duration :: Word
- selftext :: Maybe Body
}
data PollSubmission t = PollSubmission (Poll t) SubmissionOptions
mkPoll :: (Foldable t, MonadThrow m) => t Text -> Word -> m (Poll t)
data GalleryImage = GalleryImage {
- imagePath :: FilePath
- caption :: Maybe Body
- outboundURL :: Maybe URL
}
mkGalleryImage :: FilePath -> GalleryImage
galleryImageToUpload :: GalleryImage -> UploadURL -> GalleryUploadImage
data GallerySubmission t = GallerySubmission (t GalleryUploadImage) SubmissionOptions
data InlineMedia = InlineMedia {
- mediaType :: InlineMediaType
- mediaPath :: FilePath
- key :: Text
- caption :: Maybe Body
}
data InlineMediaType
- = InlineImage
- | InlineGIF
- | InlineVideo
data InlineMediaUpload = InlineMediaUpload {
- mediaType :: InlineMediaType
- mediaID :: UploadURL
- caption :: Body
- key :: Text
}
inlineMediaToUpload :: InlineMedia -> UploadURL -> InlineMediaUpload
writeInlineMedia :: InlineMediaUpload -> Body
data Fancypants
data PostedSubmission
data Search = Search {
- q :: Text
- subreddit :: Maybe SubredditName
- syntax :: Maybe SearchSyntax
}
data SearchSort
- = ByRelevance
- | ByNew
- | ByHot
- | ByTop
- | ByComments
data SearchCategory
mkSearchCategory :: MonadThrow m => Text -> m SearchCategory
data SearchOpts = SearchOpts {
- searchSort :: SearchSort
- searchTime :: Time
- category :: Maybe SearchCategory
}
newtype ResultID = ResultID SubmissionID
data SearchSyntax
- = Lucene
- | Cloudsearch
- | PlainSyntax
mkSearch :: Text -> Search

Documentation

data Submission Source #

A submitted self-text post or link

Constructors

Submission

Fields

Instances

Instances details

Eq Submission Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: Submission -> Submission -> Bool # (/=) :: Submission -> Submission -> Bool #
Show Submission Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> Submission -> ShowS # show :: Submission -> String # showList :: [Submission] -> ShowS #
Generic Submission Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep Submission :: Type -> Type # Methods from :: Submission -> Rep Submission x # to :: Rep Submission x -> Submission #
FromJSON Submission Source #
Instance details Defined in Network.Reddit.Types.Submission Methods parseJSON :: Value -> Parser Submission # parseJSONList :: Value -> Parser [Submission] #
Paginable Submission Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type PaginateOptions Submission Source # type PaginateThing Submission Source # Methods defaultOpts :: PaginateOptions Submission Source # getFullname :: Submission -> PaginateThing Submission Source # optsToForm :: PaginateOptions Submission -> Form Source #
FromJSON (PostedItem Submission) Source #
Instance details Defined in Network.Reddit.Types.Item Methods parseJSON :: Value -> Parser (PostedItem Submission) # parseJSONList :: Value -> Parser [PostedItem Submission] #
type Rep Submission Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep Submission = D1 ('MetaData "Submission" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Submission" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "submissionID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionID) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username))) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionContent) :: (S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)))) :: ((S1 ('MetaSel ('Just "edited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UTCTime)) :: (S1 ('MetaSel ('Just "permalink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Domain))) :: ((S1 ('MetaSel ('Just "numComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "ups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "downs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))) :: (((S1 ('MetaSel ('Just "upvoteRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Rational)) :: (S1 ('MetaSel ('Just "gilded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: 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 "isOC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "clicked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "locked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "spoiler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "pollData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PollData)) :*: S1 ('MetaSel ('Just "allAwardings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Awarding))))))))
type PaginateOptions Submission Source #
Instance details Defined in Network.Reddit.Types.Submission type PaginateOptions Submission = ItemOpts
type PaginateThing Submission Source #
Instance details Defined in Network.Reddit.Types.Submission type PaginateThing Submission = SubmissionID

newtype SubmissionID Source #

Unique, site-wide ID for a Submission

Constructors

SubmissionID Text

Instances

Instances details

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

data SubmissionContent Source #

The contents of the Submission. Can be a self-post with a plaintext and HTML body, an external link, or entirely empty

Constructors

SelfText Body Body
ExternalLink URL
EmptySubmission

Instances

Instances details

Eq SubmissionContent Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: SubmissionContent -> SubmissionContent -> Bool # (/=) :: SubmissionContent -> SubmissionContent -> Bool #
Show SubmissionContent Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> SubmissionContent -> ShowS # show :: SubmissionContent -> String # showList :: [SubmissionContent] -> ShowS #
Generic SubmissionContent Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep SubmissionContent :: Type -> Type # Methods from :: SubmissionContent -> Rep SubmissionContent x # to :: Rep SubmissionContent x -> SubmissionContent #
type Rep SubmissionContent Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep SubmissionContent = D1 ('MetaData "SubmissionContent" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SelfText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)) :+: (C1 ('MetaCons "ExternalLink" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL)) :+: C1 ('MetaCons "EmptySubmission" 'PrefixI 'False) (U1 :: Type -> Type)))

submissionP :: Object -> Parser Submission Source #

Parse a Submission

data PollData Source #

Data from an existing submission containing a poll. See Poll for submitting a new post with a poll

Constructors

PollData
Fields options :: Seq PollOption totalVoteCount :: Integer Total number of votes cast for the poll votingEnds :: UTCTime Voting end date for the poll userSelection :: Maybe PollOptionID The option selected by the authenticated user, if any

Instances

Instances details

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

data PollOption Source #

Single option in existing PollData

Constructors

PollOption
Fields pollOptionID :: PollOptionID text :: Body voteCount :: Integer The total number of votes received thus far

Instances

Instances details

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

type PollOptionID = Text Source #

Identifier for a PollOption

Collections

data Collection Source #

Represents a Reddit collection

Constructors

Collection

Fields

collectionID :: CollectionID
author :: Username
title :: Title
subredditID :: SubredditID
description :: Body
permalink :: URL
created :: UTCTime
lastUpdated :: UTCTime
linkIDs :: Seq SubmissionID
sortedLinks :: Seq Submission
These are the Submissions that correspond to the IDs in the linkIDs fields. This field may be empty, depending on how the Collection was obtained. Fetching all of the collections belonging to a subreddit will not include it, whereas fetching an individual collection by ID will
layout :: Maybe CollectionLayout

Instances

Instances details

Eq Collection Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: Collection -> Collection -> Bool # (/=) :: Collection -> Collection -> Bool #
Show Collection Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> Collection -> ShowS # show :: Collection -> String # showList :: [Collection] -> ShowS #
Generic Collection Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep Collection :: Type -> Type # Methods from :: Collection -> Rep Collection x # to :: Rep Collection x -> Collection #
FromJSON Collection Source #
Instance details Defined in Network.Reddit.Types.Submission Methods parseJSON :: Value -> Parser Collection # parseJSONList :: Value -> Parser [Collection] #
type Rep Collection Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep Collection = D1 ('MetaData "Collection" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Collection" 'PrefixI 'True) (((S1 ('MetaSel ('Just "collectionID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CollectionID) :: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username)) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :: (S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditID) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)))) :: ((S1 ('MetaSel ('Just "permalink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))) :: (S1 ('MetaSel ('Just "linkIDs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq SubmissionID)) :: (S1 ('MetaSel ('Just "sortedLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Submission)) :: S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionLayout)))))))

data CollectionLayout Source #

The layout of the Collection on the redesigned site

Constructors

Gallery
Timeline

Instances

Instances details

Eq CollectionLayout Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: CollectionLayout -> CollectionLayout -> Bool # (/=) :: CollectionLayout -> CollectionLayout -> Bool #
Show CollectionLayout Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> CollectionLayout -> ShowS # show :: CollectionLayout -> String # showList :: [CollectionLayout] -> ShowS #
Generic CollectionLayout Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep CollectionLayout :: Type -> Type # Methods from :: CollectionLayout -> Rep CollectionLayout x # to :: Rep CollectionLayout x -> CollectionLayout #
FromJSON CollectionLayout Source #
Instance details Defined in Network.Reddit.Types.Submission Methods parseJSON :: Value -> Parser CollectionLayout # parseJSONList :: Value -> Parser [CollectionLayout] #
ToHttpApiData CollectionLayout Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toUrlPiece :: CollectionLayout -> Text # toEncodedUrlPiece :: CollectionLayout -> Builder # toHeader :: CollectionLayout -> ByteString # toQueryParam :: CollectionLayout -> Text #
type Rep CollectionLayout Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep CollectionLayout = D1 ('MetaData "CollectionLayout" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Gallery" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Timeline" 'PrefixI 'False) (U1 :: Type -> Type))

type CollectionID = Text Source #

A UUID identifier for a Collection

data NewCollection Source #

Data to create a new Collection as a moderator action

Constructors

NewCollection
Fields title :: Title description :: Body subredditID :: SubredditID layout :: Maybe CollectionLayout

Instances

Instances details

Eq NewCollection Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: NewCollection -> NewCollection -> Bool # (/=) :: NewCollection -> NewCollection -> Bool #
Show NewCollection Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> NewCollection -> ShowS # show :: NewCollection -> String # showList :: [NewCollection] -> ShowS #
Generic NewCollection Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep NewCollection :: Type -> Type # Methods from :: NewCollection -> Rep NewCollection x # to :: Rep NewCollection x -> NewCollection #
ToForm NewCollection Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toForm :: NewCollection -> Form #
type Rep NewCollection Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep NewCollection = D1 ('MetaData "NewCollection" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "NewCollection" 'PrefixI 'True) ((S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)) :: (S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditID) :*: S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionLayout)))))

Creating submissions

data SubmissionOptions Source #

Components to create a new submission

Constructors

SubmissionOptions

Fields

title :: Title
Should be <= 300 characters in length
subreddit :: SubredditName
nsfw :: Bool
sendreplies :: Bool
resubmit :: Bool
spoiler :: Bool
collectionID :: Maybe CollectionID
The UUID of an existing Collection to which to add the new submission
flairID :: Maybe FlairID
flairText :: Maybe FlairText
If this is chosen, two conditions must be met that are not currently enforced by this library: * The flairID field above must also be provided * The textEditable field of the associated FlairTemplate must also be True

Instances

Instances details

Eq SubmissionOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: SubmissionOptions -> SubmissionOptions -> Bool # (/=) :: SubmissionOptions -> SubmissionOptions -> Bool #
Show SubmissionOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> SubmissionOptions -> ShowS # show :: SubmissionOptions -> String # showList :: [SubmissionOptions] -> ShowS #
Generic SubmissionOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep SubmissionOptions :: Type -> Type # Methods from :: SubmissionOptions -> Rep SubmissionOptions x # to :: Rep SubmissionOptions x -> SubmissionOptions #
ToForm SubmissionOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toForm :: SubmissionOptions -> Form #
type Rep SubmissionOptions Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep SubmissionOptions = D1 ('MetaData "SubmissionOptions" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SubmissionOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :: S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName)) :: (S1 ('MetaSel ('Just "nsfw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "sendreplies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "resubmit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "spoiler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "collectionID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CollectionID)) :: (S1 ('MetaSel ('Just "flairID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairID)) :: S1 ('MetaSel ('Just "flairText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairText)))))))

mkSubmissionOptions :: SubredditName -> Title -> SubmissionOptions Source #

Create a SubmissionOptions with default values for most fields

data NewSubmission Source #

The type of SubmissionOptions to submit to Reddit. In general, this should not be used directly. See instead the various submit actions in Network.Reddit.Submission

Constructors

SelfPost Body SubmissionOptions
WithInlineMedia Fancypants SubmissionOptions	The body should be generated using `InlineMedia` and converted to "fancypants" style markdown. Please see `submitWithInlineMedia`, which handles this
Link URL SubmissionOptions
ImagePost UploadURL SubmissionOptions	Please see `submitImage` in order to create an image submission. The URL must point to a valid image hosted by Reddit
VideoPost UploadURL UploadURL Bool SubmissionOptions	See the note for `ImagePost` about `UploadURL`s. The `Bool` argument specifies if this is "videogif" media. The second `UploadURL` points to a Reddit-hosted thumbnail image

Instances

Instances details

Eq NewSubmission Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: NewSubmission -> NewSubmission -> Bool # (/=) :: NewSubmission -> NewSubmission -> Bool #
Show NewSubmission Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> NewSubmission -> ShowS # show :: NewSubmission -> String # showList :: [NewSubmission] -> ShowS #
Generic NewSubmission Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep NewSubmission :: Type -> Type # Methods from :: NewSubmission -> Rep NewSubmission x # to :: Rep NewSubmission x -> NewSubmission #
ToForm NewSubmission Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toForm :: NewSubmission -> Form #
type Rep NewSubmission Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep NewSubmission = D1 ('MetaData "NewSubmission" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "SelfPost" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionOptions)) :+: C1 ('MetaCons "WithInlineMedia" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Fancypants) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionOptions))) :+: (C1 ('MetaCons "Link" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionOptions)) :+: (C1 ('MetaCons "ImagePost" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionOptions)) :+: C1 ('MetaCons "VideoPost" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL)) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionOptions))))))

data S3UploadLease Source #

Used to upload style assets and images to Reddit's servers when submitting content

Constructors

S3UploadLease
Fields action :: URL fields :: HashMap Text Text S3 metadata and headers key :: Text This is required to get the final upload URL websocketURL :: URL assetID :: UploadURL

Instances

Instances details

Eq S3UploadLease Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: S3UploadLease -> S3UploadLease -> Bool # (/=) :: S3UploadLease -> S3UploadLease -> Bool #
Show S3UploadLease Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> S3UploadLease -> ShowS # show :: S3UploadLease -> String # showList :: [S3UploadLease] -> ShowS #
Generic S3UploadLease Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep S3UploadLease :: Type -> Type # Methods from :: S3UploadLease -> Rep S3UploadLease x # to :: Rep S3UploadLease x -> S3UploadLease #
FromJSON S3UploadLease Source #
Instance details Defined in Network.Reddit.Types.Submission Methods parseJSON :: Value -> Parser S3UploadLease # parseJSONList :: Value -> Parser [S3UploadLease] #
type Rep S3UploadLease Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep S3UploadLease = D1 ('MetaData "S3UploadLease" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "S3UploadLease" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "websocketURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: S1 ('MetaSel ('Just "assetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL)))))

data UploadType Source #

Used to distinguish upload types when creating submissions with media

Constructors

SelfPostUpload
LinkUpload
GalleryUpload

Instances

Instances details

Eq UploadType Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: UploadType -> UploadType -> Bool # (/=) :: UploadType -> UploadType -> Bool #
Show UploadType Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> UploadType -> ShowS # show :: UploadType -> String # showList :: [UploadType] -> ShowS #
Generic UploadType Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep UploadType :: Type -> Type # Methods from :: UploadType -> Rep UploadType x # to :: Rep UploadType x -> UploadType #
type Rep UploadType Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep UploadType = D1 ('MetaData "UploadType" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SelfPostUpload" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LinkUpload" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "GalleryUpload" 'PrefixI 'False) (U1 :: Type -> Type)))

data UploadResult Source #

Result issued from a websocket connection after uploading media

Constructors

UploadResult
Fields resultType :: Text redirectURL :: URL

Instances

Instances details

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

data CrosspostOptions Source #

Options for crossposting a submission

Constructors

CrosspostOptions
Fields subreddit :: SubredditName title :: Title nsfw :: Bool sendreplies :: Bool spoiler :: Bool flairID :: Maybe FlairID flairText :: Maybe FlairText If this is chosen, two conditions must be met that are not currently enforced by this library: * The `flairID` field above must also be provided * The `textEditable` field of the associated `FlairTemplate` must also be `True`

Instances

Instances details

Eq CrosspostOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: CrosspostOptions -> CrosspostOptions -> Bool # (/=) :: CrosspostOptions -> CrosspostOptions -> Bool #
Show CrosspostOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> CrosspostOptions -> ShowS # show :: CrosspostOptions -> String # showList :: [CrosspostOptions] -> ShowS #
Generic CrosspostOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep CrosspostOptions :: Type -> Type # Methods from :: CrosspostOptions -> Rep CrosspostOptions x # to :: Rep CrosspostOptions x -> CrosspostOptions #
ToForm CrosspostOptions Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toForm :: CrosspostOptions -> Form #
type Rep CrosspostOptions Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep CrosspostOptions = D1 ('MetaData "CrosspostOptions" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CrosspostOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :: S1 ('MetaSel ('Just "nsfw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "sendreplies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "spoiler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "flairID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairID)) :: S1 ('MetaSel ('Just "flairText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairText))))))

mkCrosspostOptions :: SubredditName -> Title -> CrosspostOptions Source #

CrosspostOptions with default values for most fields

data PostedCrosspost Source #

Wrapper for getting the submission ID after completing a crosspost

Instances

Instances details

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

data Poll t Source #

A Reddit poll. See mkPoll to create a new one satisfying Reddit constraints on poll options and duration

Constructors

Poll
Fields options :: t Text Between 2 and 6 total options duration :: Word The number of days for the poll to run selftext :: Maybe Body Optional self text for the body of the submission

Instances

Instances details

Eq (t Text) => Eq (Poll t) Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: Poll t -> Poll t -> Bool # (/=) :: Poll t -> Poll t -> Bool #
Show (t Text) => Show (Poll t) Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> Poll t -> ShowS # show :: Poll t -> String # showList :: [Poll t] -> ShowS #
Generic (Poll t) Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep (Poll t) :: Type -> Type # Methods from :: Poll t -> Rep (Poll t) x # to :: Rep (Poll t) x -> Poll t #
type Rep (Poll t) Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep (Poll t) = D1 ('MetaData "Poll" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Poll" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (t Text)) :: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word) :: S1 ('MetaSel ('Just "selftext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)))))

data PollSubmission t Source #

Wrapper providing a single ToJSON instance for Polls and SubmissionOptionss together

Constructors

PollSubmission (Poll t) SubmissionOptions

Instances

Instances details

Generic (PollSubmission t) Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep (PollSubmission t) :: Type -> Type # Methods from :: PollSubmission t -> Rep (PollSubmission t) x # to :: Rep (PollSubmission t) x -> PollSubmission t #
Foldable t => ToJSON (PollSubmission t) Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toJSON :: PollSubmission t -> Value # toEncoding :: PollSubmission t -> Encoding # toJSONList :: [PollSubmission t] -> Value # toEncodingList :: [PollSubmission t] -> Encoding #
type Rep (PollSubmission t) Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep (PollSubmission t) = D1 ('MetaData "PollSubmission" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "PollSubmission" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Poll t)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubmissionOptions)))

mkPoll :: (Foldable t, MonadThrow m) => t Text -> Word -> m (Poll t) Source #

Create a new Poll, validating the following constraints: * The duration is between 1 and 7 * The number of options is between 2 and 6

data GalleryImage Source #

A single image in a gallery submission

Constructors

GalleryImage
Fields imagePath :: FilePath caption :: Maybe Body Optional caption outboundURL :: Maybe URL Optional outbound URL

Instances

Instances details

Eq GalleryImage Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: GalleryImage -> GalleryImage -> Bool # (/=) :: GalleryImage -> GalleryImage -> Bool #
Show GalleryImage Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> GalleryImage -> ShowS # show :: GalleryImage -> String # showList :: [GalleryImage] -> ShowS #
Generic GalleryImage Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep GalleryImage :: Type -> Type # Methods from :: GalleryImage -> Rep GalleryImage x # to :: Rep GalleryImage x -> GalleryImage #
type Rep GalleryImage Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep GalleryImage = D1 ('MetaData "GalleryImage" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "GalleryImage" 'PrefixI 'True) (S1 ('MetaSel ('Just "imagePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath) :: (S1 ('MetaSel ('Just "caption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: S1 ('MetaSel ('Just "outboundURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)))))

mkGalleryImage :: FilePath -> GalleryImage Source #

Create a GalleryImage with default values for the caption and outboundURL fields

galleryImageToUpload :: GalleryImage -> UploadURL -> GalleryUploadImage Source #

Convert a GalleryImage to to GalleryUploadImage after obtaining the UploadURL

data GallerySubmission t Source #

Wrapper providing a single ToJSON instance for a container of GalleryUploadImages and SubmissionOptionss together

Constructors

GallerySubmission (t GalleryUploadImage) SubmissionOptions

Instances

Instances details

Generic (GallerySubmission t) Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep (GallerySubmission t) :: Type -> Type # Methods from :: GallerySubmission t -> Rep (GallerySubmission t) x # to :: Rep (GallerySubmission t) x -> GallerySubmission t #
Foldable t => ToJSON (GallerySubmission t) Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toJSON :: GallerySubmission t -> Value # toEncoding :: GallerySubmission t -> Encoding # toJSONList :: [GallerySubmission t] -> Value # toEncodingList :: [GallerySubmission t] -> Encoding #
type Rep (GallerySubmission t) Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep (GallerySubmission t)

data InlineMedia Source #

A piece of inline media that can be added to a self-text post

Constructors

InlineMedia

Fields

mediaType :: InlineMediaType
mediaPath :: FilePath
The path must be valid and the file type must correspond to the provided mediaType field
key :: Text
This corresponds to a placeholder in the self-text of the submission. This will be filled in with generated markdown. If the key is absent from the text, the inline media will not be included in the final body. See submitWithInlineMedia for more details
caption :: Maybe Body
Optional caption for the media

Instances

Instances details

Eq InlineMedia Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: InlineMedia -> InlineMedia -> Bool # (/=) :: InlineMedia -> InlineMedia -> Bool #
Show InlineMedia Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> InlineMedia -> ShowS # show :: InlineMedia -> String # showList :: [InlineMedia] -> ShowS #
Generic InlineMedia Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep InlineMedia :: Type -> Type # Methods from :: InlineMedia -> Rep InlineMedia x # to :: Rep InlineMedia x -> InlineMedia #
type Rep InlineMedia Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep InlineMedia = D1 ('MetaData "InlineMedia" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "InlineMedia" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InlineMediaType) :: S1 ('MetaSel ('Just "mediaPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath)) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "caption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)))))

data InlineMediaType Source #

The type of inline media

Constructors

InlineImage
InlineGIF
InlineVideo

Instances

Instances details

Eq InlineMediaType Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: InlineMediaType -> InlineMediaType -> Bool # (/=) :: InlineMediaType -> InlineMediaType -> Bool #
Show InlineMediaType Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> InlineMediaType -> ShowS # show :: InlineMediaType -> String # showList :: [InlineMediaType] -> ShowS #
Generic InlineMediaType Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep InlineMediaType :: Type -> Type # Methods from :: InlineMediaType -> Rep InlineMediaType x # to :: Rep InlineMediaType x -> InlineMediaType #
ToHttpApiData InlineMediaType Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toUrlPiece :: InlineMediaType -> Text # toEncodedUrlPiece :: InlineMediaType -> Builder # toHeader :: InlineMediaType -> ByteString # toQueryParam :: InlineMediaType -> Text #
type Rep InlineMediaType Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep InlineMediaType = D1 ('MetaData "InlineMediaType" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "InlineImage" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InlineGIF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InlineVideo" 'PrefixI 'False) (U1 :: Type -> Type)))

data InlineMediaUpload Source #

As an InlineMedia, but after obtaining the URL for the Reddit-hosted image

Constructors

InlineMediaUpload
Fields mediaType :: InlineMediaType mediaID :: UploadURL caption :: Body key :: Text

Instances

Instances details

Eq InlineMediaUpload Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: InlineMediaUpload -> InlineMediaUpload -> Bool # (/=) :: InlineMediaUpload -> InlineMediaUpload -> Bool #
Show InlineMediaUpload Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> InlineMediaUpload -> ShowS # show :: InlineMediaUpload -> String # showList :: [InlineMediaUpload] -> ShowS #
Generic InlineMediaUpload Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep InlineMediaUpload :: Type -> Type # Methods from :: InlineMediaUpload -> Rep InlineMediaUpload x # to :: Rep InlineMediaUpload x -> InlineMediaUpload #
type Rep InlineMediaUpload Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep InlineMediaUpload = D1 ('MetaData "InlineMediaUpload" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "InlineMediaUpload" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InlineMediaType) :: S1 ('MetaSel ('Just "mediaID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL)) :: (S1 ('MetaSel ('Just "caption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

inlineMediaToUpload :: InlineMedia -> UploadURL -> InlineMediaUpload Source #

Convert an InlineMedia to InlineMediaUpload after obtaining the UploadURL

writeInlineMedia :: InlineMediaUpload -> Body Source #

Write an InlineMediaUpload in markdown format

data Fancypants Source #

Represents richtext JSON object. This should be generated through an API endpoint

Instances

Instances details

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

data PostedSubmission Source #

Wrapper for getting the URL from the JSON object that is returned when posting a new submissions

Instances

Instances details

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

Search

data Search Source #

The text to search, along with an optional SubredditName

Constructors

Search
Fields q :: Text The text to search subreddit :: Maybe SubredditName If `Nothing`, will perform search. Should be <= 512 characters in length syntax :: Maybe SearchSyntax If `Nothing`, defaults to `Lucene`

Instances

Instances details

Eq Search Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: Search -> Search -> Bool # (/=) :: Search -> Search -> Bool #
Show Search Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> Search -> ShowS # show :: Search -> String # showList :: [Search] -> ShowS #
Generic Search Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep Search :: Type -> Type # Methods from :: Search -> Rep Search x # to :: Rep Search x -> Search #
ToForm Search Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toForm :: Search -> Form #
Paginable Search Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type PaginateOptions Search Source # type PaginateThing Search Source # Methods defaultOpts :: PaginateOptions Search Source # getFullname :: Search -> PaginateThing Search Source # optsToForm :: PaginateOptions Search -> Form Source #
type Rep Search Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep Search = D1 ('MetaData "Search" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Search" 'PrefixI 'True) (S1 ('MetaSel ('Just "q") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "subreddit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SubredditName)) :: S1 ('MetaSel ('Just "syntax") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SearchSyntax)))))
type PaginateOptions Search Source #
Instance details Defined in Network.Reddit.Types.Submission type PaginateOptions Search = SearchOpts
type PaginateThing Search Source #
Instance details Defined in Network.Reddit.Types.Submission type PaginateThing Search = Text

data SearchSort Source #

The sort order for Searches

Constructors

ByRelevance
ByNew
ByHot
ByTop
ByComments

Instances

Instances details

Eq SearchSort Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: SearchSort -> SearchSort -> Bool # (/=) :: SearchSort -> SearchSort -> Bool #
Show SearchSort Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> SearchSort -> ShowS # show :: SearchSort -> String # showList :: [SearchSort] -> ShowS #
Generic SearchSort Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep SearchSort :: Type -> Type # Methods from :: SearchSort -> Rep SearchSort x # to :: Rep SearchSort x -> SearchSort #
ToHttpApiData SearchSort Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toUrlPiece :: SearchSort -> Text # toEncodedUrlPiece :: SearchSort -> Builder # toHeader :: SearchSort -> ByteString # toQueryParam :: SearchSort -> Text #
type Rep SearchSort Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep SearchSort = D1 ('MetaData "SearchSort" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) ((C1 ('MetaCons "ByRelevance" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ByNew" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ByHot" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ByTop" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ByComments" 'PrefixI 'False) (U1 :: Type -> Type))))

data SearchCategory Source #

The category for the Search

Instances

Instances details

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

mkSearchCategory :: MonadThrow m => Text -> m SearchCategory Source #

Create a SearchCategory from Text, the length of which must not exceed 5 characters

data SearchOpts Source #

Options for paginating and filtering Searches

Constructors

SearchOpts
Fields searchSort :: SearchSort searchTime :: Time category :: Maybe SearchCategory

Instances

Instances details

Eq SearchOpts Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: SearchOpts -> SearchOpts -> Bool # (/=) :: SearchOpts -> SearchOpts -> Bool #
Show SearchOpts Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> SearchOpts -> ShowS # show :: SearchOpts -> String # showList :: [SearchOpts] -> ShowS #
Generic SearchOpts Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep SearchOpts :: Type -> Type # Methods from :: SearchOpts -> Rep SearchOpts x # to :: Rep SearchOpts x -> SearchOpts #
ToForm SearchOpts Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toForm :: SearchOpts -> Form #
type Rep SearchOpts Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep SearchOpts = D1 ('MetaData "SearchOpts" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SearchOpts" 'PrefixI 'True) (S1 ('MetaSel ('Just "searchSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SearchSort) :: (S1 ('MetaSel ('Just "searchTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Time) :: S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SearchCategory)))))

newtype ResultID Source #

A wrapper around SubmissionIDs that allows Listing ResultID a to be distinguished from Listing SubmissionID a

Constructors

ResultID SubmissionID

Instances

Instances details

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

data SearchSyntax Source #

The syntax to use in the Search

Constructors

Lucene
Cloudsearch
PlainSyntax

Instances

Instances details

Eq SearchSyntax Source #
Instance details Defined in Network.Reddit.Types.Submission Methods (==) :: SearchSyntax -> SearchSyntax -> Bool # (/=) :: SearchSyntax -> SearchSyntax -> Bool #
Show SearchSyntax Source #
Instance details Defined in Network.Reddit.Types.Submission Methods showsPrec :: Int -> SearchSyntax -> ShowS # show :: SearchSyntax -> String # showList :: [SearchSyntax] -> ShowS #
Generic SearchSyntax Source #
Instance details Defined in Network.Reddit.Types.Submission Associated Types type Rep SearchSyntax :: Type -> Type # Methods from :: SearchSyntax -> Rep SearchSyntax x # to :: Rep SearchSyntax x -> SearchSyntax #
ToHttpApiData SearchSyntax Source #
Instance details Defined in Network.Reddit.Types.Submission Methods toUrlPiece :: SearchSyntax -> Text # toEncodedUrlPiece :: SearchSyntax -> Builder # toHeader :: SearchSyntax -> ByteString # toQueryParam :: SearchSyntax -> Text #
type Rep SearchSyntax Source #
Instance details Defined in Network.Reddit.Types.Submission type Rep SearchSyntax = D1 ('MetaData "SearchSyntax" "Network.Reddit.Types.Submission" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Lucene" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Cloudsearch" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PlainSyntax" 'PrefixI 'False) (U1 :: Type -> Type)))

mkSearch :: Text -> Search Source #

Create a new Search by providing the query, with defaults for the other fields