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

Contents

Actions
Subreddit Listings
Collections
Flair
Wiki
Widgets
Emojis
Types

Description

Synopsis

getSubreddit :: MonadReddit m => SubredditName -> m Subreddit
getSubredditRules :: MonadReddit m => SubredditName -> m (Seq SubredditRule)
getPostRequirements :: MonadReddit m => SubredditName -> m PostRequirements
getHotSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getNewSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getRandomRisingSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getControversialSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getRisingSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getTopSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission)
getRandomSubmission :: MonadReddit m => SubredditName -> m Submission
getStickiedSubmission :: MonadReddit m => Maybe Word -> SubredditName -> m Submission
subscribe :: MonadReddit m => SubredditName -> m ()
unsubscribe :: MonadReddit m => SubredditName -> m ()
quarantineOptIn :: MonadReddit m => SubredditName -> m ()
quarantineOptOut :: MonadReddit m => SubredditName -> m ()
getDefaultSubreddits :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
getNewSubreddits :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
getPopularSubreddits :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
getPremiumSubreddits :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
getGoldSubreddits :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
searchSubreddits :: MonadReddit m => Text -> Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)
searchSubredditsByName :: MonadReddit m => Maybe Bool -> Maybe Bool -> Text -> m (Seq SubredditName)
getRecommendedSubreddits :: (MonadReddit m, Foldable t) => Maybe (t SubredditName) -> t SubredditName -> m (Seq SubredditName)
followCollection :: MonadReddit m => CollectionID -> m ()
unfollowCollection :: MonadReddit m => CollectionID -> m ()
getCollections :: MonadReddit m => SubredditID -> m (Seq Collection)
getCollectionsWithName :: MonadReddit m => SubredditName -> m (Seq Collection)
getCollection :: MonadReddit m => CollectionID -> m Collection
getCollectionByPermalink :: MonadReddit m => URL -> m Collection
getUserFlairTemplates :: MonadReddit m => SubredditName -> m (Seq FlairTemplate)
getSubmissionFlairTemplates :: MonadReddit m => SubredditName -> m (Seq FlairTemplate)
getNewSubmissionFlairChoices :: MonadReddit m => SubredditName -> m (Seq FlairChoice)
getUserFlairChoices :: MonadReddit m => SubredditName -> m (Seq FlairChoice)
getSubmissionFlairChoices :: MonadReddit m => SubredditName -> SubmissionID -> m (Seq FlairChoice)
getWikiPage :: MonadReddit m => SubredditName -> WikiPageName -> m WikiPage
getWikiPages :: MonadReddit m => SubredditName -> m (Seq WikiPageName)
getWikiPageRevision :: MonadReddit m => SubredditName -> WikiPageName -> WikiRevisionID -> m WikiPage
getWikiPageRevisions :: MonadReddit m => SubredditName -> WikiPageName -> Paginator WikiRevisionID WikiRevision -> m (Listing WikiRevisionID WikiRevision)
editWikiPage :: MonadReddit m => SubredditName -> WikiPageName -> Maybe Text -> Body -> m ()
createWikiPage :: MonadReddit m => SubredditName -> WikiPageName -> Maybe Text -> Body -> m ()
getSubredditWidgets :: MonadReddit m => SubredditName -> m SubredditWidgets
getAllSubredditWidgets :: MonadReddit m => SubredditName -> m (Seq Widget)
getSubredditEmojis :: MonadReddit m => SubredditName -> m (Seq Emoji)
data BodyRestriction
- = BodyRequired
- | BodyNotAllowed
- | NoRestriction
data PostRequirements = PostRequirements [Text] BodyRestriction [Text] [Text] Bool [Text] [Text] (Maybe Word) (Maybe Word)
data RuleType
- = CommentRule
- | LinkRule
- | AllRule
data PostedSubredditRule
data NewSubredditRule = NewSubredditRule Name RuleType Body (Maybe Text)
data SubredditRule = SubredditRule Body Body Name UTCTime Word (Maybe Text) (Maybe RuleType)
newtype SubredditID = SubredditID Text
data SubredditName
data Subreddit = Subreddit SubredditID SubredditName Title UTCTime SubredditType Integer Body (Maybe RGBText) Body (Maybe Body) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe URL) (Maybe URL) (Maybe (Int, Int)) (Maybe URL) (Maybe (Int, Int)) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) (Maybe Bool) (Maybe Bool)
mkSubredditName :: MonadThrow m => Text -> m SubredditName
data ForegroundColor
- = Dark
- | Light
data FlairContent
- = AllContent
- | EmojisOnly
- | TextOnly
data FlairType
- = UserFlairType
- | SubmissionFlairType
data FlairResult = FlairResult Bool Text (HashMap Text Text) (HashMap Text Text)
data FlairSelection = FlairSelection FlairChoice (Maybe Text) SubredditName
data CurrentUserFlair
data UserFlair = UserFlair (Maybe FlairText) (Maybe CSSClass)
data FlairChoiceList
data FlairChoice = FlairChoice FlairID FlairText Bool (Maybe CSSClass)
data PostedFlairTemplate
data FlairTemplate = FlairTemplate (Maybe FlairID) FlairText Bool (Maybe ForegroundColor) (Maybe RGBText) (Maybe CSSClass) (Maybe Bool) Word Bool FlairContent
type FlairID = Text
data FlairList = FlairList (Maybe UserID) (Maybe UserID) (Seq AssignedFlair)
data AssignedFlair = AssignedFlair Username (Maybe FlairText) (Maybe CSSClass)
type CSSClass = Text
data FlairText
mkFlairText :: MonadThrow m => Text -> m FlairText
flairlistToListing :: FlairList -> Listing UserID AssignedFlair
defaultFlairTemplate :: FlairTemplate
data EmojiName
data Emoji = Emoji EmojiName Bool Bool Bool (Maybe UserID) (Maybe UploadURL)
mkEmoji :: EmojiName -> Emoji
mkEmojiName :: MonadThrow m => Text -> m EmojiName
data TextAreaWidget = TextAreaWidget (Maybe WidgetID) ShortName Body (Maybe Body) (Maybe WidgetStyles)
data RulesDisplay
- = FullDisplay
- | CompactDisplay
data RulesWidget = RulesWidget (Maybe WidgetID) ShortName (Seq SubredditRule) RulesDisplay (Maybe WidgetStyles)
data PostFlairWidgetDisplay
- = CloudDisplay
- | ListDisplay
data PostFlairInfo = PostFlairInfo FlairID Text ForegroundColor RGBText
data PostFlairWidget = PostFlairWidget (Maybe WidgetID) ShortName (Seq FlairID) (HashMap FlairID PostFlairInfo) PostFlairWidgetDisplay (Maybe WidgetStyles)
data ModInfo = ModInfo Username (Maybe FlairText) (Maybe ForegroundColor) (Maybe RGBText)
data ModeratorsWidget = ModeratorsWidget (Maybe WidgetID) (Seq ModInfo) (Maybe Int) (Maybe WidgetStyles)
data MenuLink = MenuLink Text URL
data Submenu = Submenu (Seq MenuLink) Text
data MenuChild
- = SubmenuChild Submenu
- | MenuLinkChild MenuLink
data MenuWidget = MenuWidget (Maybe WidgetID) (Seq MenuChild)
data Image = Image Integer Integer UploadURL (Maybe URL)
data ImageWidget = ImageWidget (Maybe WidgetID) ShortName (Seq Image) (Maybe WidgetStyles)
data IDCardWidget = IDCardWidget (Maybe WidgetID) ShortName Body Text Text (Maybe Integer) (Maybe Integer) (Maybe WidgetStyles)
data ImageData = ImageData Name Int Int UploadURL
data CustomWidget = CustomWidget (Maybe WidgetID) ShortName Body (Seq ImageData) Int (Maybe Body) (Maybe Text) (Maybe URL) (Maybe WidgetStyles)
data CommunityInfo = CommunityInfo SubredditName (Maybe Integer) (Maybe RGBText) (Maybe URL) (Maybe URL) (Maybe Bool) (Maybe Bool)
data CommunityListWidget = CommunityListWidget (Maybe WidgetID) ShortName (Seq CommunityInfo) (Maybe WidgetStyles)
data CalendarConfig = CalendarConfig Word Bool Bool Bool Bool Bool
data CalendarWidget = CalendarWidget (Maybe WidgetID) ShortName Text CalendarConfig Bool (Maybe WidgetStyles)
data TextHover = TextHover ShortName (Maybe RGBText) (Maybe RGBText) (Maybe RGBText)
data ImageHover = ImageHover UploadURL (Maybe Integer) (Maybe Integer)
data ButtonHover
- = ImageButtonHover ImageHover
- | TextButtonHover TextHover
data ButtonText = ButtonText ShortName URL RGBText (Maybe RGBText) (Maybe RGBText) (Maybe ButtonHover)
data ButtonImage = ButtonImage ShortName UploadURL URL Int Int (Maybe ButtonHover)
data Button
- = ImageButton ButtonImage
- | TextButton ButtonText
data ButtonWidget = ButtonWidget (Maybe WidgetID) ShortName (Seq Button) Body (Maybe Body) (Maybe WidgetStyles)
data WidgetStyles = WidgetStyles (Maybe RGBText) (Maybe RGBText)
data ShortName
data WidgetSection
- = Topbar
- | Sidebar
newtype WidgetID = WidgetID Text
data Widget
- = Buttons ButtonWidget
- | Calendar CalendarWidget
- | CommunityList CommunityListWidget
- | Custom CustomWidget
- | IDCard IDCardWidget
- | Images ImageWidget
- | Moderators ModeratorsWidget
- | Menu MenuWidget
- | PostFlair PostFlairWidget
- | Rules RulesWidget
- | TextArea TextAreaWidget
data SubredditWidgets = SubredditWidgets IDCardWidget ModeratorsWidget (Seq Widget) (Seq Widget) (Seq WidgetID) (Seq WidgetID)
mkShortName :: MonadThrow m => Text -> m ShortName
defaultCalendarConfig :: CalendarConfig
mkCommunityInfo :: SubredditName -> CommunityInfo
mkPostFlairWidget :: ShortName -> Seq FlairID -> PostFlairWidget
mkTextAreaWidget :: ShortName -> Body -> TextAreaWidget
data WikiPermLevel
- = FollowWikiSettings
- | ApprovedEditorsOnly
- | ModEditsOnly
data WikiPageSettings = WikiPageSettings WikiPermLevel Bool (Seq Username)
data WikiPageListing
data WikiRevisionID
data WikiRevision = WikiRevision WikiRevisionID WikiPageName UTCTime Username (Maybe Text) (Maybe Bool)
data WikiPageName
data WikiPage = WikiPage Body Body Username UTCTime Bool
mkWikiPageName :: Text -> WikiPageName

Actions

getSubreddit :: MonadReddit m => SubredditName -> m Subreddit Source #

Get information about a Subreddit. An ErrorWithStatus will be thrown if attempting to query information on banned or private Subreddits

getSubredditRules :: MonadReddit m => SubredditName -> m (Seq SubredditRule) Source #

Get a Subreddit's SubredditRules

getPostRequirements :: MonadReddit m => SubredditName -> m PostRequirements Source #

Get the requirements that moderators have configured for all submissions on the given subreddit

getHotSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get "hot" Submissions for a given Subreddit

getNewSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get "new" Submissions for a given Subreddit

getRandomRisingSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get "rising" Submissions for a given Subreddit

getControversialSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get "controversial" Submissions for a given Subreddit

getRisingSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get "rising" Submissions for a given Subreddit

getTopSubmissions :: MonadReddit m => SubredditName -> Paginator SubmissionID Submission -> m (Listing SubmissionID Submission) Source #

Get "top" Submissions for a given Subreddit

getRandomSubmission :: MonadReddit m => SubredditName -> m Submission Source #

Get a random submission from the subreddit. The sub must support this feature, or an ErrorWithStatus exception will be thrown

getStickiedSubmission Source #

Arguments

:: MonadReddit m
=> Maybe Word	Which sticky to fetch. 1 is at the top of the sticky list, and is the default if this param is `Nothing`
-> SubredditName
-> m Submission

Get one of the stickied submission, optionally specifying its position in the sticky list, returning the top one otherwise. Note that this will throw an ErrorWithStatus if the sub does not have any stickied submissions

subscribe :: MonadReddit m => SubredditName -> m () Source #

Subscribe to a single subreddit

unsubscribe :: MonadReddit m => SubredditName -> m () Source #

Unsubscribe from a single subreddit

quarantineOptIn :: MonadReddit m => SubredditName -> m () Source #

Allow the authenticated user to access the quarantined subreddit

quarantineOptOut :: MonadReddit m => SubredditName -> m () Source #

Disallow the authenticated user from accessing the quarantined subreddit

Subreddit `Listing`s

These actions return Listings of subreddits site-wide corresponding to various filters

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

Get a Listing of the default Subreddits

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

Get a Listing of new Subreddits site-wide

Get a Listing of popular Subreddits site-wide

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

Get a Listing of premium-only Subreddits

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

Same as getPremiumSubreddits, provided for compatibility purposes

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

Search through subreddits based on both their names and descriptions

searchSubredditsByName Source #

Arguments

:: MonadReddit m
=> Maybe Bool	If NSWF subreddits should be included, defaulting to `True` if `Nothing`
-> Maybe Bool	Only exactly match the query, defaulting to `False` if `Nothing`
-> Text
-> m (Seq SubredditName)

Search through subreddits based on both their names

getRecommendedSubreddits Source #

Arguments

:: (MonadReddit m, Foldable t)
=> Maybe (t SubredditName)	Subreddits to omit from the result
-> t SubredditName	Subreddits to base the recommendations on
-> m (Seq SubredditName)

Get a list of recommended subreddits based on the provided subs. Subreddits to exclude from the recommendation may optionally be provided.

Note: Unfortunately, as of this writing, this action appears to only return an empty array for all inputs

followCollection :: MonadReddit m => CollectionID -> m () Source #

Follow the collection for the authenticated user

unfollowCollection :: MonadReddit m => CollectionID -> m () Source #

Unfollow the collection for the authenticated user

Collections

getCollections :: MonadReddit m => SubredditID -> m (Seq Collection) Source #

Get the Collections of a subreddit, given the sub ID. Collections obtained through this action will not have the sortedLinks field

Note: if you don't know the ID of the subreddit, you can use getNamedCollections, although this incurs an additional network request to get the ID from the name

getCollectionsWithName :: MonadReddit m => SubredditName -> m (Seq Collection) Source #

Get the Collections of a subreddit, given the name of the sub. Collections obtained through this action will not have the sortedLinks field

Note: this incurs a greater overhead than getCollections, which you may want to use if you already know the subredditID

getCollection :: MonadReddit m => CollectionID -> m Collection Source #

Fetch the specifig Collection, given its ID. This includes its sortedLinks

getCollectionByPermalink :: MonadReddit m => URL -> m Collection Source #

Get a Collection given its permalink. This includes its sortedLinks

Permalink URLs should be of the form https://{www.}reddit.com/r/<SUBREDDIT>/collections/<ID>

Flair

getUserFlairTemplates :: MonadReddit m => SubredditName -> m (Seq FlairTemplate) Source #

Get the user FlairTemplates on the given subreddit. This will throw an APIException (ErrorWithStatus) if the sub does not allow users to set their own flair and the authenticated user does not have mod privileges on the sub

getSubmissionFlairTemplates :: MonadReddit m => SubredditName -> m (Seq FlairTemplate) Source #

Get the submission FlairTemplates on the given subreddit

getNewSubmissionFlairChoices :: MonadReddit m => SubredditName -> m (Seq FlairChoice) Source #

Get the available FlairChoices for new submissions on the given subreddit

getUserFlairChoices :: MonadReddit m => SubredditName -> m (Seq FlairChoice) Source #

Get the available FlairChoices for new submissions on the current subreddit

getSubmissionFlairChoices :: MonadReddit m => SubredditName -> SubmissionID -> m (Seq FlairChoice) Source #

Get the available FlairChoices for a particular submission on the given subreddit

Wiki

getWikiPage :: MonadReddit m => SubredditName -> WikiPageName -> m WikiPage Source #

Get the subreddit WikiPage specified by name

getWikiPages :: MonadReddit m => SubredditName -> m (Seq WikiPageName) Source #

Get all of the WikiPages on the subreddit wiki

getWikiPageRevision :: MonadReddit m => SubredditName -> WikiPageName -> WikiRevisionID -> m WikiPage Source #

Get a specific revision of a WikiPage, specified by name and WikiRevisionID

getWikiPageRevisions :: MonadReddit m => SubredditName -> WikiPageName -> Paginator WikiRevisionID WikiRevision -> m (Listing WikiRevisionID WikiRevision) Source #

Get a Listing of the WikiRevisions for a given wikipage

editWikiPage Source #

Arguments

:: MonadReddit m
=> SubredditName
-> WikiPageName
-> Maybe Text	The reason for the edit, if any
-> Body	The new content for the page
-> m ()

Edit the given wikipage, replacing its contents with the new contents provided. This requires moderator privileges or editing privileges for the page in question. If the page corresponding to the given name does not exist, it will be created

createWikiPage Source #

Arguments

:: MonadReddit m
=> SubredditName
-> WikiPageName
-> Maybe Text	The reason for creating the page, if any
-> Body	The new content for the page
-> m ()

Create a new wikipage. If a page with the given name already exists, its contents will be replaced

Widgets

getSubredditWidgets :: MonadReddit m => SubredditName -> m SubredditWidgets Source #

Get a given subreddit's widgets

getAllSubredditWidgets :: MonadReddit m => SubredditName -> m (Seq Widget) Source #

Get all of a subreddit's Widgets as a non-hierarchical list

Emojis

getSubredditEmojis :: MonadReddit m => SubredditName -> m (Seq Emoji) Source #

Get all of the emojis for the given subreddit. Note that this does not include the builtin "snoomojis"

Types

data BodyRestriction Source #

Rules concerning the presence of self-text bodies in posts

Constructors

BodyRequired
BodyNotAllowed
NoRestriction

Instances

Instances details

Eq BodyRestriction Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods (==) :: BodyRestriction -> BodyRestriction -> Bool # (/=) :: BodyRestriction -> BodyRestriction -> Bool #
Show BodyRestriction Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods showsPrec :: Int -> BodyRestriction -> ShowS # show :: BodyRestriction -> String # showList :: [BodyRestriction] -> ShowS #
Generic BodyRestriction Source #
Instance details Defined in Network.Reddit.Types.Subreddit Associated Types type Rep BodyRestriction :: Type -> Type # Methods from :: BodyRestriction -> Rep BodyRestriction x # to :: Rep BodyRestriction x -> BodyRestriction #
FromJSON BodyRestriction Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods parseJSON :: Value -> Parser BodyRestriction # parseJSONList :: Value -> Parser [BodyRestriction] #
type Rep BodyRestriction Source #
Instance details Defined in Network.Reddit.Types.Subreddit type Rep BodyRestriction = D1 ('MetaData "BodyRestriction" "Network.Reddit.Types.Subreddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "BodyRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "BodyNotAllowed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoRestriction" 'PrefixI 'False) (U1 :: Type -> Type)))

data PostRequirements Source #

Mod-created requirements for posting in a subreddit

Constructors

PostRequirements [Text] BodyRestriction [Text] [Text] Bool [Text] [Text] (Maybe Word) (Maybe Word)

Instances

Instances details

Eq PostRequirements Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods (==) :: PostRequirements -> PostRequirements -> Bool # (/=) :: PostRequirements -> PostRequirements -> Bool #
Show PostRequirements Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods showsPrec :: Int -> PostRequirements -> ShowS # show :: PostRequirements -> String # showList :: [PostRequirements] -> ShowS #
Generic PostRequirements Source #
Instance details Defined in Network.Reddit.Types.Subreddit Associated Types type Rep PostRequirements :: Type -> Type # Methods from :: PostRequirements -> Rep PostRequirements x # to :: Rep PostRequirements x -> PostRequirements #
FromJSON PostRequirements Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods parseJSON :: Value -> Parser PostRequirements # parseJSONList :: Value -> Parser [PostRequirements] #
type Rep PostRequirements Source #
Instance details Defined in Network.Reddit.Types.Subreddit type Rep PostRequirements = D1 ('MetaData "PostRequirements" "Network.Reddit.Types.Subreddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "PostRequirements" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bodyBlacklistedStrings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "bodyRestrictionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BodyRestriction)) :: (S1 ('MetaSel ('Just "domainBlacklist") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "domainWhitelist") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) :: ((S1 ('MetaSel ('Just "isFlairRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "titleBlacklistedStrings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])) :: (S1 ('MetaSel ('Just "titleRequiredStrings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: (S1 ('MetaSel ('Just "titleTextMaxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Word)) :: S1 ('MetaSel ('Just "titleTextMinLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Word)))))))

data RuleType Source #

The type of item that a SubredditRule applies to

Constructors

CommentRule
LinkRule
AllRule

Instances

Instances details

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

data PostedSubredditRule Source #

Wrapper for parsing newly created SubredditRules, after POSTing a NewSubredditRule. Rather unbelievably, Reddit transmits these new rules as a JSON object ... in a single element array ... encoded as a string ... inside another object!

Instances

Instances details

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

data NewSubredditRule Source #

Represents a new SubredditRule that can be created by moderators

Constructors

NewSubredditRule Name RuleType Body (Maybe Text)

Instances

Instances details

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

data SubredditRule Source #

A Subreddit rule. If you are a moderator, you can update the shortName, description, violationReason, and ruleType fields. See reorderSubredditRules. New rules may also be created with NewSubredditRules

Constructors

SubredditRule Body Body Name UTCTime Word (Maybe Text) (Maybe RuleType)

Instances

Instances details

Eq SubredditRule Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods (==) :: SubredditRule -> SubredditRule -> Bool # (/=) :: SubredditRule -> SubredditRule -> Bool #
Show SubredditRule Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods showsPrec :: Int -> SubredditRule -> ShowS # show :: SubredditRule -> String # showList :: [SubredditRule] -> ShowS #
Generic SubredditRule Source #
Instance details Defined in Network.Reddit.Types.Subreddit Associated Types type Rep SubredditRule :: Type -> Type # Methods from :: SubredditRule -> Rep SubredditRule x # to :: Rep SubredditRule x -> SubredditRule #
FromJSON SubredditRule Source #	Depending on the endpoint, the JSON fields are either camel- or snake-cased
Instance details Defined in Network.Reddit.Types.Subreddit Methods parseJSON :: Value -> Parser SubredditRule # parseJSONList :: Value -> Parser [SubredditRule] #
ToForm SubredditRule Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods toForm :: SubredditRule -> Form #
type Rep SubredditRule Source #
Instance details Defined in Network.Reddit.Types.Subreddit type Rep SubredditRule = D1 ('MetaData "SubredditRule" "Network.Reddit.Types.Subreddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SubredditRule" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: (S1 ('MetaSel ('Just "descriptionHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name))) :: ((S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word)) :: (S1 ('MetaSel ('Just "violationReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ruleType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleType))))))

newtype SubredditID Source #

Unique site-wide identifier for a subreddit

Constructors

SubredditID Text

Instances

Instances details

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

data SubredditName Source #

The name of a subreddit

Instances

Instances details

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

data Subreddit Source #

Information about a subreddit. Fields prefixed with userIs below apply to the currently authenticated user

Constructors

Subreddit SubredditID SubredditName Title UTCTime SubredditType Integer Body (Maybe RGBText) Body (Maybe Body) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe URL) (Maybe URL) (Maybe (Int, Int)) (Maybe URL) (Maybe (Int, Int)) Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool Bool (Maybe Bool) (Maybe Bool) (Maybe Bool)

Instances

Instances details

Eq Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods (==) :: Subreddit -> Subreddit -> Bool # (/=) :: Subreddit -> Subreddit -> Bool #
Show Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods showsPrec :: Int -> Subreddit -> ShowS # show :: Subreddit -> String # showList :: [Subreddit] -> ShowS #
Generic Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit Associated Types type Rep Subreddit :: Type -> Type # Methods from :: Subreddit -> Rep Subreddit x # to :: Rep Subreddit x -> Subreddit #
FromJSON Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit Methods parseJSON :: Value -> Parser Subreddit # parseJSONList :: Value -> Parser [Subreddit] #
Paginable Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit Associated Types type PaginateOptions Subreddit Source # type PaginateThing Subreddit Source # Methods defaultOpts :: PaginateOptions Subreddit Source # getFullname :: Subreddit -> PaginateThing Subreddit Source # optsToForm :: PaginateOptions Subreddit -> Form Source #
type Rep Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit type Rep Subreddit = D1 ('MetaData "Subreddit" "Network.Reddit.Types.Subreddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Subreddit" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "subredditID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditID) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName)) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Title) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))) :: ((S1 ('MetaSel ('Just "subredditType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditType) :: S1 ('MetaSel ('Just "subscribers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "publicDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: (S1 ('MetaSel ('Just "keyColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body))))) :: (((S1 ('MetaSel ('Just "descriptionHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: S1 ('MetaSel ('Just "submitText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "submitTextHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "submitTextLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "iconImg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)) :: S1 ('MetaSel ('Just "bannerImg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL))) :: (S1 ('MetaSel ('Just "bannerSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Int, Int))) :: (S1 ('MetaSel ('Just "headerImg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)) :: S1 ('MetaSel ('Just "headerSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Int, Int)))))))) :: ((((S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "quarantine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "userIsBanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "userIsMuted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "userIsModerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "userIsContributor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "userIsSubscriber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "allowImages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "allowPolls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))) :: (((S1 ('MetaSel ('Just "allowVideos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "allowVideoGIFs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "freeFormReports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "restrictPosting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: ((S1 ('MetaSel ('Just "restrictCommenting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "linkFlairEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "canAssignLinkFlair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "canAssignUserFlair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "spoilersEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))))
type PaginateOptions Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit type PaginateOptions Subreddit = ()
type PaginateThing Subreddit Source #
Instance details Defined in Network.Reddit.Types.Subreddit type PaginateThing Subreddit = SubredditID

mkSubredditName :: MonadThrow m => Text -> m SubredditName Source #

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

data ForegroundColor Source #

Foreground color for v2 flair

Constructors

Dark
Light

Instances

Instances details

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

data FlairContent Source #

The type of content that is allowed in a flair template

Constructors

AllContent
EmojisOnly
TextOnly

Instances

Instances details

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

data FlairType Source #

The type of flair, when creating a new template

Constructors

UserFlairType
SubmissionFlairType

Instances

Instances details

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

data FlairResult Source #

The result of bulk setting of users' flairs as a mod action. The warnings and errors fields may be dynamically generated by Reddit, so they are represented here as HashMaps

Constructors

FlairResult Bool Text (HashMap Text Text) (HashMap Text Text)

Instances

Instances details

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

data FlairSelection Source #

Select a FlairChoice for a submission or for the user

Constructors

FlairSelection FlairChoice (Maybe Text) SubredditName

Instances

Instances details

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

data CurrentUserFlair Source #

Wrapper around UserFlair for fetching the current flair. This uses the same endpoint as the FlairChoiceList above

Instances

Instances details

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

data UserFlair Source #

Flair that is currently assigned to a user

Constructors

UserFlair (Maybe FlairText) (Maybe CSSClass)

Instances

Instances details

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

data FlairChoiceList Source #

Instances

Instances details

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

data FlairChoice Source #

Information about flair that a user can choose. The templateID corresponds to the flairID field of a FlairTemplate

Constructors

FlairChoice FlairID FlairText Bool (Maybe CSSClass)

Instances

Instances details

Eq FlairChoice Source #
Instance details Defined in Network.Reddit.Types.Flair Methods (==) :: FlairChoice -> FlairChoice -> Bool # (/=) :: FlairChoice -> FlairChoice -> Bool #
Show FlairChoice Source #
Instance details Defined in Network.Reddit.Types.Flair Methods showsPrec :: Int -> FlairChoice -> ShowS # show :: FlairChoice -> String # showList :: [FlairChoice] -> ShowS #
Generic FlairChoice Source #
Instance details Defined in Network.Reddit.Types.Flair Associated Types type Rep FlairChoice :: Type -> Type # Methods from :: FlairChoice -> Rep FlairChoice x # to :: Rep FlairChoice x -> FlairChoice #
FromJSON FlairChoice Source #
Instance details Defined in Network.Reddit.Types.Flair Methods parseJSON :: Value -> Parser FlairChoice # parseJSONList :: Value -> Parser [FlairChoice] #
type Rep FlairChoice Source #
Instance details Defined in Network.Reddit.Types.Flair type Rep FlairChoice = D1 ('MetaData "FlairChoice" "Network.Reddit.Types.Flair" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "FlairChoice" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlairID) :: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlairText)) :: (S1 ('MetaSel ('Just "textEditable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "cssClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CSSClass)))))

data PostedFlairTemplate Source #

Wrapper around FlairTemplates for posting via the API. If the flairID field is Nothing, a new template will be created. Otherwise, the template with the matching ID will be updated

Instances

Instances details

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

data FlairTemplate Source #

Flair "templates" that describe choices for self-assigned flair, for both users and submissions

Constructors

FlairTemplate (Maybe FlairID) FlairText Bool (Maybe ForegroundColor) (Maybe RGBText) (Maybe CSSClass) (Maybe Bool) Word Bool FlairContent

Instances

Instances details

Eq FlairTemplate Source #
Instance details Defined in Network.Reddit.Types.Flair Methods (==) :: FlairTemplate -> FlairTemplate -> Bool # (/=) :: FlairTemplate -> FlairTemplate -> Bool #
Show FlairTemplate Source #
Instance details Defined in Network.Reddit.Types.Flair Methods showsPrec :: Int -> FlairTemplate -> ShowS # show :: FlairTemplate -> String # showList :: [FlairTemplate] -> ShowS #
Generic FlairTemplate Source #
Instance details Defined in Network.Reddit.Types.Flair Associated Types type Rep FlairTemplate :: Type -> Type # Methods from :: FlairTemplate -> Rep FlairTemplate x # to :: Rep FlairTemplate x -> FlairTemplate #
FromJSON FlairTemplate Source #
Instance details Defined in Network.Reddit.Types.Flair Methods parseJSON :: Value -> Parser FlairTemplate # parseJSONList :: Value -> Parser [FlairTemplate] #
ToForm FlairTemplate Source #
Instance details Defined in Network.Reddit.Types.Flair Methods toForm :: FlairTemplate -> Form #
type Rep FlairTemplate Source #
Instance details Defined in Network.Reddit.Types.Flair type Rep FlairTemplate = D1 ('MetaData "FlairTemplate" "Network.Reddit.Types.Flair" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "FlairTemplate" 'PrefixI 'True) (((S1 ('MetaSel ('Just "flairID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairID)) :: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlairText)) :: (S1 ('MetaSel ('Just "textEditable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "textColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ForegroundColor)) :: S1 ('MetaSel ('Just "backgroundColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText))))) :: ((S1 ('MetaSel ('Just "cssClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CSSClass)) :: S1 ('MetaSel ('Just "overrideCSS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "maxEmojis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word) :: (S1 ('MetaSel ('Just "modOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "allowableContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FlairContent))))))

type FlairID = Text Source #

An identifier for a FlairTemplate

data FlairList Source #

Reddit strangely does not use their usual Listing mechanism for paginating assigned flairs, but a different data structure

Constructors

FlairList (Maybe UserID) (Maybe UserID) (Seq AssignedFlair)

Instances

Instances details

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

data AssignedFlair Source #

Flair that has been, or will be, assigned to a user

Constructors

AssignedFlair Username (Maybe FlairText) (Maybe CSSClass)

Instances

Instances details

Eq AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair Methods (==) :: AssignedFlair -> AssignedFlair -> Bool # (/=) :: AssignedFlair -> AssignedFlair -> Bool #
Show AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair Methods showsPrec :: Int -> AssignedFlair -> ShowS # show :: AssignedFlair -> String # showList :: [AssignedFlair] -> ShowS #
Generic AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair Associated Types type Rep AssignedFlair :: Type -> Type # Methods from :: AssignedFlair -> Rep AssignedFlair x # to :: Rep AssignedFlair x -> AssignedFlair #
FromJSON AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair Methods parseJSON :: Value -> Parser AssignedFlair # parseJSONList :: Value -> Parser [AssignedFlair] #
Paginable AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair Associated Types type PaginateOptions AssignedFlair Source # type PaginateThing AssignedFlair Source # Methods defaultOpts :: PaginateOptions AssignedFlair Source # getFullname :: AssignedFlair -> PaginateThing AssignedFlair Source # optsToForm :: PaginateOptions AssignedFlair -> Form Source #
type Rep AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair type Rep AssignedFlair = D1 ('MetaData "AssignedFlair" "Network.Reddit.Types.Flair" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "AssignedFlair" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairText)) :: S1 ('MetaSel ('Just "cssClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CSSClass)))))
type PaginateOptions AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair type PaginateOptions AssignedFlair = ()
type PaginateThing AssignedFlair Source #
Instance details Defined in Network.Reddit.Types.Flair type PaginateThing AssignedFlair = Text

type CSSClass = Text Source #

CSS class for flair

data FlairText Source #

The text displayed by the FlairTemplate

Instances

Instances details

Eq FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods (==) :: FlairText -> FlairText -> Bool # (/=) :: FlairText -> FlairText -> Bool #
Show FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods showsPrec :: Int -> FlairText -> ShowS # show :: FlairText -> String # showList :: [FlairText] -> ShowS #
Generic FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Associated Types type Rep FlairText :: Type -> Type # Methods from :: FlairText -> Rep FlairText x # to :: Rep FlairText x -> FlairText #
Semigroup FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods (<>) :: FlairText -> FlairText -> FlairText # sconcat :: NonEmpty FlairText -> FlairText # stimes :: Integral b => b -> FlairText -> FlairText #
Monoid FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods mempty :: FlairText # mappend :: FlairText -> FlairText -> FlairText # mconcat :: [FlairText] -> FlairText #
ToJSON FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods toJSON :: FlairText -> Value # toEncoding :: FlairText -> Encoding # toJSONList :: [FlairText] -> Value # toEncodingList :: [FlairText] -> Encoding #
FromJSON FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods parseJSON :: Value -> Parser FlairText # parseJSONList :: Value -> Parser [FlairText] #
ToHttpApiData FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair Methods toUrlPiece :: FlairText -> Text # toEncodedUrlPiece :: FlairText -> Builder # toHeader :: FlairText -> ByteString # toQueryParam :: FlairText -> Text #
type Rep FlairText Source #
Instance details Defined in Network.Reddit.Types.Flair type Rep FlairText = D1 ('MetaData "FlairText" "Network.Reddit.Types.Flair" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'True) (C1 ('MetaCons "FlairText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkFlairText :: MonadThrow m => Text -> m FlairText Source #

Smart constructor for FlairText, the length of which not exceed 64 characters

flairlistToListing :: FlairList -> Listing UserID AssignedFlair Source #

Convert a FlairList to a Listing, allowing it to be used with other functions/actions expecting a listing

defaultFlairTemplate :: FlairTemplate Source #

A FlairTemplate with default fields, for convenience when creating new templates

data EmojiName Source #

The name of an individual Emoji

Instances

Instances details

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

data Emoji Source #

A single emoji. This can either be one of Reddit's builtin "snoomojis" or a custom emoji for a subreddit. See mkEmoji for creating news ones

Constructors

Emoji EmojiName Bool Bool Bool (Maybe UserID) (Maybe UploadURL)

Instances

Instances details

Eq Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods (==) :: Emoji -> Emoji -> Bool # (/=) :: Emoji -> Emoji -> Bool #
Show Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods showsPrec :: Int -> Emoji -> ShowS # show :: Emoji -> String # showList :: [Emoji] -> ShowS #
Generic Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Associated Types type Rep Emoji :: Type -> Type # Methods from :: Emoji -> Rep Emoji x # to :: Rep Emoji x -> Emoji #
FromJSON Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods parseJSON :: Value -> Parser Emoji # parseJSONList :: Value -> Parser [Emoji] #
ToForm Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji Methods toForm :: Emoji -> Form #
type Rep Emoji Source #
Instance details Defined in Network.Reddit.Types.Emoji type Rep Emoji = D1 ('MetaData "Emoji" "Network.Reddit.Types.Emoji" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Emoji" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmojiName) :: (S1 ('MetaSel ('Just "modFlairOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "postFlairAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: (S1 ('MetaSel ('Just "userFlairAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserID)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UploadURL))))))

mkEmoji :: EmojiName -> Emoji Source #

Create a new Emoji by providing an EmojiName; default values are provided for all other fields

mkEmojiName :: MonadThrow m => Text -> m EmojiName Source #

Smart constructor for EmojiNames, which may only contain alphanumeric characters, '_', '-', and '&', and may not exceed 24 characters in length

data TextAreaWidget Source #

A widget composed of text. See mkTextAreaWidget for constructing a new widget

Constructors

TextAreaWidget (Maybe WidgetID) ShortName Body (Maybe Body) (Maybe WidgetStyles)

Instances

Instances details

Eq TextAreaWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: TextAreaWidget -> TextAreaWidget -> Bool # (/=) :: TextAreaWidget -> TextAreaWidget -> Bool #
Show TextAreaWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> TextAreaWidget -> ShowS # show :: TextAreaWidget -> String # showList :: [TextAreaWidget] -> ShowS #
Generic TextAreaWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep TextAreaWidget :: Type -> Type # Methods from :: TextAreaWidget -> Rep TextAreaWidget x # to :: Rep TextAreaWidget x -> TextAreaWidget #
ToJSON TextAreaWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: TextAreaWidget -> Value # toEncoding :: TextAreaWidget -> Encoding # toJSONList :: [TextAreaWidget] -> Value # toEncodingList :: [TextAreaWidget] -> Encoding #
FromJSON TextAreaWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser TextAreaWidget # parseJSONList :: Value -> Parser [TextAreaWidget] #
type Rep TextAreaWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep TextAreaWidget = D1 ('MetaData "TextAreaWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "TextAreaWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName)) :: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: (S1 ('MetaSel ('Just "textHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles))))))

data RulesDisplay Source #

Display style for a RulesWidget

Constructors

FullDisplay
CompactDisplay

Instances

Instances details

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

data RulesWidget Source #

A widget listing subreddit SubredditRules. The rules field cannot be updated through widget endpoints, and are excluded during serialization

Constructors

RulesWidget (Maybe WidgetID) ShortName (Seq SubredditRule) RulesDisplay (Maybe WidgetStyles)

Instances

Instances details

Eq RulesWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: RulesWidget -> RulesWidget -> Bool # (/=) :: RulesWidget -> RulesWidget -> Bool #
Show RulesWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> RulesWidget -> ShowS # show :: RulesWidget -> String # showList :: [RulesWidget] -> ShowS #
Generic RulesWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep RulesWidget :: Type -> Type # Methods from :: RulesWidget -> Rep RulesWidget x # to :: Rep RulesWidget x -> RulesWidget #
ToJSON RulesWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: RulesWidget -> Value # toEncoding :: RulesWidget -> Encoding # toJSONList :: [RulesWidget] -> Value # toEncodingList :: [RulesWidget] -> Encoding #
FromJSON RulesWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser RulesWidget # parseJSONList :: Value -> Parser [RulesWidget] #
type Rep RulesWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep RulesWidget = D1 ('MetaData "RulesWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "RulesWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName)) :: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq SubredditRule)) :: (S1 ('MetaSel ('Just "display") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RulesDisplay) :: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles))))))

data PostFlairWidgetDisplay Source #

The display orientation for PostFlairWidgets

Constructors

CloudDisplay
ListDisplay

Instances

Instances details

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

data PostFlairInfo Source #

Information about submission flair templates in a PostFlairWidget

Constructors

PostFlairInfo FlairID Text ForegroundColor RGBText

Instances

Instances details

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

data PostFlairWidget Source #

A widget listing flair choices for submissions. When creating a new widget, the FlairIDs in the order field must be valid template IDs for the given subreddit. Existing flair templates can be obtained with getSubmissionFlairTemplates, which can then be mapped over to obtain the IDs. Once the flair IDs have been obtained, mkPostFlairWidget can be used to construct a widget with default values for most fields

Constructors

PostFlairWidget (Maybe WidgetID) ShortName (Seq FlairID) (HashMap FlairID PostFlairInfo) PostFlairWidgetDisplay (Maybe WidgetStyles)

Instances

Instances details

Eq PostFlairWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: PostFlairWidget -> PostFlairWidget -> Bool # (/=) :: PostFlairWidget -> PostFlairWidget -> Bool #
Show PostFlairWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> PostFlairWidget -> ShowS # show :: PostFlairWidget -> String # showList :: [PostFlairWidget] -> ShowS #
Generic PostFlairWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep PostFlairWidget :: Type -> Type # Methods from :: PostFlairWidget -> Rep PostFlairWidget x # to :: Rep PostFlairWidget x -> PostFlairWidget #
ToJSON PostFlairWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: PostFlairWidget -> Value # toEncoding :: PostFlairWidget -> Encoding # toJSONList :: [PostFlairWidget] -> Value # toEncodingList :: [PostFlairWidget] -> Encoding #
FromJSON PostFlairWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser PostFlairWidget # parseJSONList :: Value -> Parser [PostFlairWidget] #
type Rep PostFlairWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep PostFlairWidget = D1 ('MetaData "PostFlairWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "PostFlairWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: (S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName) :: S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq FlairID)))) :: (S1 ('MetaSel ('Just "templates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap FlairID PostFlairInfo)) :: (S1 ('MetaSel ('Just "display") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PostFlairWidgetDisplay) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles))))))

data ModInfo Source #

Information about a moderator as displayed in a ModeratorsWidget

Constructors

ModInfo Username (Maybe FlairText) (Maybe ForegroundColor) (Maybe RGBText)

Instances

Instances details

Eq ModInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ModInfo -> ModInfo -> Bool # (/=) :: ModInfo -> ModInfo -> Bool #
Show ModInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ModInfo -> ShowS # show :: ModInfo -> String # showList :: [ModInfo] -> ShowS #
Generic ModInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ModInfo :: Type -> Type # Methods from :: ModInfo -> Rep ModInfo x # to :: Rep ModInfo x -> ModInfo #
ToJSON ModInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ModInfo -> Value # toEncoding :: ModInfo -> Encoding # toJSONList :: [ModInfo] -> Value # toEncodingList :: [ModInfo] -> Encoding #
FromJSON ModInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ModInfo # parseJSONList :: Value -> Parser [ModInfo] #
type Rep ModInfo Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ModInfo = D1 ('MetaData "ModInfo" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :: S1 ('MetaSel ('Just "flairText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlairText))) :: (S1 ('MetaSel ('Just "flairTextColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ForegroundColor)) :*: S1 ('MetaSel ('Just "flairBackgroundColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)))))

data ModeratorsWidget Source #

A widget listing the moderators of the subreddit. This widget cannot be created. It can be updated by modifying the styles field only

Constructors

ModeratorsWidget (Maybe WidgetID) (Seq ModInfo) (Maybe Int) (Maybe WidgetStyles)

Instances

Instances details

Eq ModeratorsWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ModeratorsWidget -> ModeratorsWidget -> Bool # (/=) :: ModeratorsWidget -> ModeratorsWidget -> Bool #
Show ModeratorsWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ModeratorsWidget -> ShowS # show :: ModeratorsWidget -> String # showList :: [ModeratorsWidget] -> ShowS #
Generic ModeratorsWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ModeratorsWidget :: Type -> Type # Methods from :: ModeratorsWidget -> Rep ModeratorsWidget x # to :: Rep ModeratorsWidget x -> ModeratorsWidget #
ToJSON ModeratorsWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ModeratorsWidget -> Value # toEncoding :: ModeratorsWidget -> Encoding # toJSONList :: [ModeratorsWidget] -> Value # toEncodingList :: [ModeratorsWidget] -> Encoding #
FromJSON ModeratorsWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ModeratorsWidget # parseJSONList :: Value -> Parser [ModeratorsWidget] #
type Rep ModeratorsWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ModeratorsWidget = D1 ('MetaData "ModeratorsWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ModeratorsWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "mods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ModInfo))) :: (S1 ('MetaSel ('Just "totalMods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles)))))

data MenuLink Source #

A link in a MenuWidget or Submenu

Constructors

MenuLink Text URL

Instances

Instances details

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

data Submenu Source #

A submenu child in a MenuWidget which contains MenuLinks

Constructors

Submenu (Seq MenuLink) Text

Instances

Instances details

Eq Submenu Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: Submenu -> Submenu -> Bool # (/=) :: Submenu -> Submenu -> Bool #
Show Submenu Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> Submenu -> ShowS # show :: Submenu -> String # showList :: [Submenu] -> ShowS #
Generic Submenu Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep Submenu :: Type -> Type # Methods from :: Submenu -> Rep Submenu x # to :: Rep Submenu x -> Submenu #
ToJSON Submenu Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: Submenu -> Value # toEncoding :: Submenu -> Encoding # toJSONList :: [Submenu] -> Value # toEncodingList :: [Submenu] -> Encoding #
FromJSON Submenu Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser Submenu # parseJSONList :: Value -> Parser [Submenu] #
type Rep Submenu Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep Submenu = D1 ('MetaData "Submenu" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Submenu" 'PrefixI 'True) (S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq MenuLink)) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

data MenuChild Source #

A child widget in a MenuWidget

Constructors

SubmenuChild Submenu
MenuLinkChild MenuLink

Instances

Instances details

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

data MenuWidget Source #

A widget representing a menu

Constructors

MenuWidget (Maybe WidgetID) (Seq MenuChild)

Instances

Instances details

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

data Image Source #

An individual image in an ImageWidget

Constructors

Image Integer Integer UploadURL (Maybe URL)

Instances

Instances details

Eq Image Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: Image -> Image -> Bool # (/=) :: Image -> Image -> Bool #
Show Image Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> Image -> ShowS # show :: Image -> String # showList :: [Image] -> ShowS #
Generic Image Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep Image :: Type -> Type # Methods from :: Image -> Rep Image x # to :: Rep Image x -> Image #
ToJSON Image Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: Image -> Value # toEncoding :: Image -> Encoding # toJSONList :: [Image] -> Value # toEncodingList :: [Image] -> Encoding #
FromJSON Image Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser Image # parseJSONList :: Value -> Parser [Image] #
type Rep Image Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep Image = D1 ('MetaData "Image" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "Image" 'PrefixI 'True) ((S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL) :*: S1 ('MetaSel ('Just "linkURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)))))

data ImageWidget Source #

A widget composed of various Images

Constructors

ImageWidget (Maybe WidgetID) ShortName (Seq Image) (Maybe WidgetStyles)

Instances

Instances details

Eq ImageWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ImageWidget -> ImageWidget -> Bool # (/=) :: ImageWidget -> ImageWidget -> Bool #
Show ImageWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ImageWidget -> ShowS # show :: ImageWidget -> String # showList :: [ImageWidget] -> ShowS #
Generic ImageWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ImageWidget :: Type -> Type # Methods from :: ImageWidget -> Rep ImageWidget x # to :: Rep ImageWidget x -> ImageWidget #
ToJSON ImageWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ImageWidget -> Value # toEncoding :: ImageWidget -> Encoding # toJSONList :: [ImageWidget] -> Value # toEncodingList :: [ImageWidget] -> Encoding #
FromJSON ImageWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ImageWidget # parseJSONList :: Value -> Parser [ImageWidget] #
type Rep ImageWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ImageWidget = D1 ('MetaData "ImageWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ImageWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName)) :: (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Image)) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles)))))

data IDCardWidget Source #

An ID card displaying information about the subreddit

Constructors

IDCardWidget (Maybe WidgetID) ShortName Body Text Text (Maybe Integer) (Maybe Integer) (Maybe WidgetStyles)

Instances

Instances details

Eq IDCardWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: IDCardWidget -> IDCardWidget -> Bool # (/=) :: IDCardWidget -> IDCardWidget -> Bool #
Show IDCardWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> IDCardWidget -> ShowS # show :: IDCardWidget -> String # showList :: [IDCardWidget] -> ShowS #
Generic IDCardWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep IDCardWidget :: Type -> Type # Methods from :: IDCardWidget -> Rep IDCardWidget x # to :: Rep IDCardWidget x -> IDCardWidget #
ToJSON IDCardWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: IDCardWidget -> Value # toEncoding :: IDCardWidget -> Encoding # toJSONList :: [IDCardWidget] -> Value # toEncodingList :: [IDCardWidget] -> Encoding #
FromJSON IDCardWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser IDCardWidget # parseJSONList :: Value -> Parser [IDCardWidget] #
type Rep IDCardWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep IDCardWidget = D1 ('MetaData "IDCardWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "IDCardWidget" 'PrefixI 'True) (((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: S1 ('MetaSel ('Just "subscribersText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "currentlyViewingText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "subscribersCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "currentlyViewingCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles))))))

data ImageData Source #

Image data that belongs to a CustomWidget

Constructors

ImageData Name Int Int UploadURL

Instances

Instances details

Eq ImageData Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ImageData -> ImageData -> Bool # (/=) :: ImageData -> ImageData -> Bool #
Show ImageData Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ImageData -> ShowS # show :: ImageData -> String # showList :: [ImageData] -> ShowS #
Generic ImageData Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ImageData :: Type -> Type # Methods from :: ImageData -> Rep ImageData x # to :: Rep ImageData x -> ImageData #
ToJSON ImageData Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ImageData -> Value # toEncoding :: ImageData -> Encoding # toJSONList :: [ImageData] -> Value # toEncodingList :: [ImageData] -> Encoding #
FromJSON ImageData Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ImageData # parseJSONList :: Value -> Parser [ImageData] #
type Rep ImageData Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ImageData = D1 ('MetaData "ImageData" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ImageData" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL))))

data CustomWidget Source #

A custom widget

Constructors

CustomWidget (Maybe WidgetID) ShortName Body (Seq ImageData) Int (Maybe Body) (Maybe Text) (Maybe URL) (Maybe WidgetStyles)

Instances

Instances details

Eq CustomWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: CustomWidget -> CustomWidget -> Bool # (/=) :: CustomWidget -> CustomWidget -> Bool #
Show CustomWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> CustomWidget -> ShowS # show :: CustomWidget -> String # showList :: [CustomWidget] -> ShowS #
Generic CustomWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep CustomWidget :: Type -> Type # Methods from :: CustomWidget -> Rep CustomWidget x # to :: Rep CustomWidget x -> CustomWidget #
ToJSON CustomWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: CustomWidget -> Value # toEncoding :: CustomWidget -> Encoding # toJSONList :: [CustomWidget] -> Value # toEncodingList :: [CustomWidget] -> Encoding #
FromJSON CustomWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser CustomWidget # parseJSONList :: Value -> Parser [CustomWidget] #
type Rep CustomWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep CustomWidget = D1 ('MetaData "CustomWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CustomWidget" 'PrefixI 'True) (((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName)) :: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: S1 ('MetaSel ('Just "imageData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq ImageData)))) :: ((S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "textHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body))) :: (S1 ('MetaSel ('Just "css") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stylesheetURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)) :: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles)))))))

data CommunityInfo Source #

Information about a single subreddit in a CommunityListWidget. When creating a new widget, only the name field will be serialized

Constructors

CommunityInfo SubredditName (Maybe Integer) (Maybe RGBText) (Maybe URL) (Maybe URL) (Maybe Bool) (Maybe Bool)

Instances

Instances details

Eq CommunityInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: CommunityInfo -> CommunityInfo -> Bool # (/=) :: CommunityInfo -> CommunityInfo -> Bool #
Show CommunityInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> CommunityInfo -> ShowS # show :: CommunityInfo -> String # showList :: [CommunityInfo] -> ShowS #
Generic CommunityInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep CommunityInfo :: Type -> Type # Methods from :: CommunityInfo -> Rep CommunityInfo x # to :: Rep CommunityInfo x -> CommunityInfo #
ToJSON CommunityInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: CommunityInfo -> Value # toEncoding :: CommunityInfo -> Encoding # toJSONList :: [CommunityInfo] -> Value # toEncodingList :: [CommunityInfo] -> Encoding #
FromJSON CommunityInfo Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser CommunityInfo # parseJSONList :: Value -> Parser [CommunityInfo] #
type Rep CommunityInfo Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep CommunityInfo = D1 ('MetaData "CommunityInfo" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CommunityInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubredditName) :: (S1 ('MetaSel ('Just "subscribers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "primaryColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)))) :: ((S1 ('MetaSel ('Just "iconURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL)) :: S1 ('MetaSel ('Just "communityIcon") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe URL))) :: (S1 ('MetaSel ('Just "isSubscribed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "isNSFW") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

data CommunityListWidget Source #

A widget listing related subreddits

Constructors

CommunityListWidget (Maybe WidgetID) ShortName (Seq CommunityInfo) (Maybe WidgetStyles)

Instances

Instances details

Eq CommunityListWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: CommunityListWidget -> CommunityListWidget -> Bool # (/=) :: CommunityListWidget -> CommunityListWidget -> Bool #
Show CommunityListWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> CommunityListWidget -> ShowS # show :: CommunityListWidget -> String # showList :: [CommunityListWidget] -> ShowS #
Generic CommunityListWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep CommunityListWidget :: Type -> Type # Methods from :: CommunityListWidget -> Rep CommunityListWidget x # to :: Rep CommunityListWidget x -> CommunityListWidget #
ToJSON CommunityListWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: CommunityListWidget -> Value # toEncoding :: CommunityListWidget -> Encoding # toJSONList :: [CommunityListWidget] -> Value # toEncodingList :: [CommunityListWidget] -> Encoding #
FromJSON CommunityListWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser CommunityListWidget # parseJSONList :: Value -> Parser [CommunityListWidget] #
type Rep CommunityListWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep CommunityListWidget = D1 ('MetaData "CommunityListWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CommunityListWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName)) :: (S1 ('MetaSel ('Just "communities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq CommunityInfo)) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles)))))

data CalendarConfig Source #

Configuration options for a CalendarWidget

Constructors

CalendarConfig Word Bool Bool Bool Bool Bool

Instances

Instances details

Eq CalendarConfig Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: CalendarConfig -> CalendarConfig -> Bool # (/=) :: CalendarConfig -> CalendarConfig -> Bool #
Show CalendarConfig Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> CalendarConfig -> ShowS # show :: CalendarConfig -> String # showList :: [CalendarConfig] -> ShowS #
Generic CalendarConfig Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep CalendarConfig :: Type -> Type # Methods from :: CalendarConfig -> Rep CalendarConfig x # to :: Rep CalendarConfig x -> CalendarConfig #
ToJSON CalendarConfig Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: CalendarConfig -> Value # toEncoding :: CalendarConfig -> Encoding # toJSONList :: [CalendarConfig] -> Value # toEncodingList :: [CalendarConfig] -> Encoding #
FromJSON CalendarConfig Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser CalendarConfig # parseJSONList :: Value -> Parser [CalendarConfig] #
type Rep CalendarConfig Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep CalendarConfig = D1 ('MetaData "CalendarConfig" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CalendarConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "numEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word) :: (S1 ('MetaSel ('Just "showDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "showDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) :: (S1 ('MetaSel ('Just "showLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "showTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "showTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

data CalendarWidget Source #

A widget representing a calendar

Constructors

CalendarWidget (Maybe WidgetID) ShortName Text CalendarConfig Bool (Maybe WidgetStyles)

Instances

Instances details

Eq CalendarWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: CalendarWidget -> CalendarWidget -> Bool # (/=) :: CalendarWidget -> CalendarWidget -> Bool #
Show CalendarWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> CalendarWidget -> ShowS # show :: CalendarWidget -> String # showList :: [CalendarWidget] -> ShowS #
Generic CalendarWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep CalendarWidget :: Type -> Type # Methods from :: CalendarWidget -> Rep CalendarWidget x # to :: Rep CalendarWidget x -> CalendarWidget #
ToJSON CalendarWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: CalendarWidget -> Value # toEncoding :: CalendarWidget -> Encoding # toJSONList :: [CalendarWidget] -> Value # toEncodingList :: [CalendarWidget] -> Encoding #
FromJSON CalendarWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser CalendarWidget # parseJSONList :: Value -> Parser [CalendarWidget] #
type Rep CalendarWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep CalendarWidget = D1 ('MetaData "CalendarWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "CalendarWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: (S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName) :: S1 ('MetaSel ('Just "googleCalendarID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CalendarConfig) :: (S1 ('MetaSel ('Just "requiresSync") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles))))))

data TextHover Source #

The state of a TextButton when hovering over it

Constructors

TextHover ShortName (Maybe RGBText) (Maybe RGBText) (Maybe RGBText)

Instances

Instances details

Eq TextHover Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: TextHover -> TextHover -> Bool # (/=) :: TextHover -> TextHover -> Bool #
Show TextHover Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> TextHover -> ShowS # show :: TextHover -> String # showList :: [TextHover] -> ShowS #
Generic TextHover Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep TextHover :: Type -> Type # Methods from :: TextHover -> Rep TextHover x # to :: Rep TextHover x -> TextHover #
ToJSON TextHover Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: TextHover -> Value # toEncoding :: TextHover -> Encoding # toJSONList :: [TextHover] -> Value # toEncodingList :: [TextHover] -> Encoding #
FromJSON TextHover Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser TextHover # parseJSONList :: Value -> Parser [TextHover] #
type Rep TextHover Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep TextHover = D1 ('MetaData "TextHover" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "TextHover" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName) :: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText))) :: (S1 ('MetaSel ('Just "fillColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)) :*: S1 ('MetaSel ('Just "textColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)))))

data ImageHover Source #

The state of an ImageButton when hovering over it

Constructors

ImageHover UploadURL (Maybe Integer) (Maybe Integer)

Instances

Instances details

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

data ButtonHover Source #

The state of the Button when hovering over it

Constructors

ImageButtonHover ImageHover
TextButtonHover TextHover

Instances

Instances details

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

data ButtonText Source #

Data for a TextButton

Constructors

ButtonText ShortName URL RGBText (Maybe RGBText) (Maybe RGBText) (Maybe ButtonHover)

Instances

Instances details

Eq ButtonText Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ButtonText -> ButtonText -> Bool # (/=) :: ButtonText -> ButtonText -> Bool #
Show ButtonText Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ButtonText -> ShowS # show :: ButtonText -> String # showList :: [ButtonText] -> ShowS #
Generic ButtonText Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ButtonText :: Type -> Type # Methods from :: ButtonText -> Rep ButtonText x # to :: Rep ButtonText x -> ButtonText #
ToJSON ButtonText Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ButtonText -> Value # toEncoding :: ButtonText -> Encoding # toJSONList :: [ButtonText] -> Value # toEncodingList :: [ButtonText] -> Encoding #
FromJSON ButtonText Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ButtonText # parseJSONList :: Value -> Parser [ButtonText] #
type Rep ButtonText Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ButtonText = D1 ('MetaData "ButtonText" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ButtonText" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :: S1 ('MetaSel ('Just "color") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RGBText))) :: (S1 ('MetaSel ('Just "fillColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)) :: (S1 ('MetaSel ('Just "textColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)) :*: S1 ('MetaSel ('Just "hoverState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ButtonHover))))))

data ButtonImage Source #

Data for an ImageButton

Constructors

ButtonImage ShortName UploadURL URL Int Int (Maybe ButtonHover)

Instances

Instances details

Eq ButtonImage Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ButtonImage -> ButtonImage -> Bool # (/=) :: ButtonImage -> ButtonImage -> Bool #
Show ButtonImage Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ButtonImage -> ShowS # show :: ButtonImage -> String # showList :: [ButtonImage] -> ShowS #
Generic ButtonImage Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ButtonImage :: Type -> Type # Methods from :: ButtonImage -> Rep ButtonImage x # to :: Rep ButtonImage x -> ButtonImage #
ToJSON ButtonImage Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ButtonImage -> Value # toEncoding :: ButtonImage -> Encoding # toJSONList :: [ButtonImage] -> Value # toEncodingList :: [ButtonImage] -> Encoding #
FromJSON ButtonImage Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ButtonImage # parseJSONList :: Value -> Parser [ButtonImage] #
type Rep ButtonImage Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ButtonImage = D1 ('MetaData "ButtonImage" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ButtonImage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName) :: (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadURL) :: S1 ('MetaSel ('Just "linkURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL))) :: (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "hoverState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ButtonHover))))))

data Button Source #

An individual button in a ButtonWidget

Constructors

ImageButton ButtonImage
TextButton ButtonText

Instances

Instances details

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

data ButtonWidget Source #

A widget containing buttons

Constructors

ButtonWidget (Maybe WidgetID) ShortName (Seq Button) Body (Maybe Body) (Maybe WidgetStyles)

Instances

Instances details

Eq ButtonWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: ButtonWidget -> ButtonWidget -> Bool # (/=) :: ButtonWidget -> ButtonWidget -> Bool #
Show ButtonWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> ButtonWidget -> ShowS # show :: ButtonWidget -> String # showList :: [ButtonWidget] -> ShowS #
Generic ButtonWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep ButtonWidget :: Type -> Type # Methods from :: ButtonWidget -> Rep ButtonWidget x # to :: Rep ButtonWidget x -> ButtonWidget #
ToJSON ButtonWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: ButtonWidget -> Value # toEncoding :: ButtonWidget -> Encoding # toJSONList :: [ButtonWidget] -> Value # toEncodingList :: [ButtonWidget] -> Encoding #
FromJSON ButtonWidget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser ButtonWidget # parseJSONList :: Value -> Parser [ButtonWidget] #
type Rep ButtonWidget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep ButtonWidget = D1 ('MetaData "ButtonWidget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "ButtonWidget" 'PrefixI 'True) ((S1 ('MetaSel ('Just "widgetID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetID)) :: (S1 ('MetaSel ('Just "shortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShortName) :: S1 ('MetaSel ('Just "buttons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Button)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body) :: (S1 ('MetaSel ('Just "descriptionHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :*: S1 ('MetaSel ('Just "styles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WidgetStyles))))))

data WidgetStyles Source #

Style options for an individual widget

Constructors

WidgetStyles (Maybe RGBText) (Maybe RGBText)

Instances

Instances details

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

data ShortName Source #

A "short name" for any widget. This name must be less than 30 characters long

Instances

Instances details

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

data WidgetSection Source #

The section in which certain Widgets appear

Constructors

Topbar
Sidebar

Instances

Instances details

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

newtype WidgetID Source #

A widget ID. These are usually prefixed with the type of widget it corresponds to, e.g. rules-2qh1i for a RulesWidget

Constructors

WidgetID Text

Instances

Instances details

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

data Widget Source #

Represents one of various kinds of widgets

Instances

data SubredditWidgets Source #

An organized collection of a subreddit's widgets

Constructors

SubredditWidgets IDCardWidget ModeratorsWidget (Seq Widget) (Seq Widget) (Seq WidgetID) (Seq WidgetID)

Instances

Instances details

Eq SubredditWidgets Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: SubredditWidgets -> SubredditWidgets -> Bool # (/=) :: SubredditWidgets -> SubredditWidgets -> Bool #
Show SubredditWidgets Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> SubredditWidgets -> ShowS # show :: SubredditWidgets -> String # showList :: [SubredditWidgets] -> ShowS #
Generic SubredditWidgets Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep SubredditWidgets :: Type -> Type # Methods from :: SubredditWidgets -> Rep SubredditWidgets x # to :: Rep SubredditWidgets x -> SubredditWidgets #
FromJSON SubredditWidgets Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser SubredditWidgets # parseJSONList :: Value -> Parser [SubredditWidgets] #
type Rep SubredditWidgets Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep SubredditWidgets = D1 ('MetaData "SubredditWidgets" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "SubredditWidgets" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idCard") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IDCardWidget) :: (S1 ('MetaSel ('Just "moderators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModeratorsWidget) :: S1 ('MetaSel ('Just "topbar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Widget)))) :: (S1 ('MetaSel ('Just "sidebar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq Widget)) :: (S1 ('MetaSel ('Just "topbarOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq WidgetID)) :*: S1 ('MetaSel ('Just "sidebarOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq WidgetID))))))

mkShortName :: MonadThrow m => Text -> m ShortName Source #

Smart constructor for ShortNames, which must be <= 30 characters long

defaultCalendarConfig :: CalendarConfig Source #

A calendar config with default values

mkCommunityInfo :: SubredditName -> CommunityInfo Source #

Convenience function for creating a new CommunityInfo, where all but one of the fields should be Nothing

mkPostFlairWidget :: ShortName -> Seq FlairID -> PostFlairWidget Source #

Make a new PostFlairWidget with default values for most fields

mkTextAreaWidget :: ShortName -> Body -> TextAreaWidget Source #

Create a new TextAreaWidget, with default values for most fields

data WikiPermLevel Source #

Editing permission level configured for a single WikiPage

Constructors

FollowWikiSettings
ApprovedEditorsOnly
ModEditsOnly

Instances

Instances details

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

data WikiPageSettings Source #

The settings that moderators have configured for a single WikiPage

Constructors

WikiPageSettings WikiPermLevel Bool (Seq Username)

Instances

Instances details

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

data WikiPageListing Source #

Wrapper for listings of WikiPages, which have their own RedditKind

Instances

Instances details

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

data WikiRevisionID Source #

ID for a wikipage revision

Instances

Instances details

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

data WikiRevision Source #

Information regarding a single WikiPage revision

Constructors

WikiRevision WikiRevisionID WikiPageName UTCTime Username (Maybe Text) (Maybe Bool)

Instances

Instances details

Eq WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods (==) :: WikiRevision -> WikiRevision -> Bool # (/=) :: WikiRevision -> WikiRevision -> Bool #
Show WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods showsPrec :: Int -> WikiRevision -> ShowS # show :: WikiRevision -> String # showList :: [WikiRevision] -> ShowS #
Generic WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type Rep WikiRevision :: Type -> Type # Methods from :: WikiRevision -> Rep WikiRevision x # to :: Rep WikiRevision x -> WikiRevision #
FromJSON WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods parseJSON :: Value -> Parser WikiRevision # parseJSONList :: Value -> Parser [WikiRevision] #
Paginable WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type PaginateOptions WikiRevision Source # type PaginateThing WikiRevision Source # Methods defaultOpts :: PaginateOptions WikiRevision Source # getFullname :: WikiRevision -> PaginateThing WikiRevision Source # optsToForm :: PaginateOptions WikiRevision -> Form Source #
type Rep WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki type Rep WikiRevision = D1 ('MetaData "WikiRevision" "Network.Reddit.Types.Wiki" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "WikiRevision" 'PrefixI 'True) ((S1 ('MetaSel ('Just "revisionID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WikiRevisionID) :: (S1 ('MetaSel ('Just "page") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WikiPageName) :: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime))) :: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Username) :: (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hidden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))
type PaginateOptions WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki type PaginateOptions WikiRevision = ()
type PaginateThing WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki type PaginateThing WikiRevision = WikiRevisionID

data WikiPageName Source #

The name of an individual wiki page. The name forms part of the URL, and should not contain spaces or uppercase characters

Instances

Instances details

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

data WikiPage Source #

An individual subreddit wikipage along with its revision information

Constructors

WikiPage Body Body Username UTCTime Bool

Instances

Instances details

Eq WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods (==) :: WikiPage -> WikiPage -> Bool # (/=) :: WikiPage -> WikiPage -> Bool #
Show WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods showsPrec :: Int -> WikiPage -> ShowS # show :: WikiPage -> String # showList :: [WikiPage] -> ShowS #
Generic WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type Rep WikiPage :: Type -> Type # Methods from :: WikiPage -> Rep WikiPage x # to :: Rep WikiPage x -> WikiPage #
FromJSON WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods parseJSON :: Value -> Parser WikiPage # parseJSONList :: Value -> Parser [WikiPage] #
type Rep WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki type Rep WikiPage = D1 ('MetaData "WikiPage" "Network.Reddit.Types.Wiki" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (C1 ('MetaCons "WikiPage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Body) :: S1 ('MetaSel ('Just "contentHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Body)) :: (S1 ('MetaSel ('Just "revisionBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Username) :: (S1 ('MetaSel ('Just "revisionDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "mayRevise") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))

mkWikiPageName :: Text -> WikiPageName Source #

Smart constructor for WikiPageNames. Lowercases the contained text, and replaces each space with a single underscore

Buttons ButtonWidget
Calendar CalendarWidget
CommunityList CommunityListWidget
Custom CustomWidget
IDCard IDCardWidget
Images ImageWidget
Moderators ModeratorsWidget
Menu MenuWidget
PostFlair PostFlairWidget
Rules RulesWidget
TextArea TextAreaWidget

Eq Widget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods (==) :: Widget -> Widget -> Bool # (/=) :: Widget -> Widget -> Bool #
Show Widget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods showsPrec :: Int -> Widget -> ShowS # show :: Widget -> String # showList :: [Widget] -> ShowS #
Generic Widget Source #
Instance details Defined in Network.Reddit.Types.Widget Associated Types type Rep Widget :: Type -> Type # Methods from :: Widget -> Rep Widget x # to :: Rep Widget x -> Widget #
ToJSON Widget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods toJSON :: Widget -> Value # toEncoding :: Widget -> Encoding # toJSONList :: [Widget] -> Value # toEncodingList :: [Widget] -> Encoding #
FromJSON Widget Source #
Instance details Defined in Network.Reddit.Types.Widget Methods parseJSON :: Value -> Parser Widget # parseJSONList :: Value -> Parser [Widget] #
type Rep Widget Source #
Instance details Defined in Network.Reddit.Types.Widget type Rep Widget = D1 ('MetaData "Widget" "Network.Reddit.Types.Widget" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" 'False) (((C1 ('MetaCons "Buttons" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ButtonWidget)) :+: C1 ('MetaCons "Calendar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CalendarWidget))) :+: (C1 ('MetaCons "CommunityList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommunityListWidget)) :+: (C1 ('MetaCons "Custom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CustomWidget)) :+: C1 ('MetaCons "IDCard" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IDCardWidget))))) :+: ((C1 ('MetaCons "Images" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageWidget)) :+: (C1 ('MetaCons "Moderators" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ModeratorsWidget)) :+: C1 ('MetaCons "Menu" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MenuWidget)))) :+: (C1 ('MetaCons "PostFlair" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PostFlairWidget)) :+: (C1 ('MetaCons "Rules" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RulesWidget)) :+: C1 ('MetaCons "TextArea" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TextAreaWidget))))))

Actions

Subreddit Listings

Collections

Flair

Wiki

Widgets

Emojis

Types

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Subreddit `Listing`s