Network.Reddit.Subreddit

Actions

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

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)

Get a Subreddit's SubredditRules

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

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)

Get "hot" Submissions for a given Subreddit

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

Get "new" Submissions for a given Subreddit

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

Get "rising" Submissions for a given Subreddit

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

Get "controversial" Submissions for a given Subreddit

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

Get "rising" Submissions for a given Subreddit

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

Get "top" Submissions for a given Subreddit

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

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

getStickiedSubmission

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 ()

Subscribe to a single subreddit

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

Unsubscribe from a single subreddit

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

Allow the authenticated user to access the quarantined subreddit

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

Disallow the authenticated user from accessing the quarantined subreddit

Subreddit Listings

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

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

Get a Listing of the default Subreddits

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

Get a Listing of new Subreddits site-wide

getPopularSubreddits :: MonadReddit m => Paginator SubredditID Subreddit -> m (Listing SubredditID Subreddit)

Get a Listing of popular Subreddits site-wide

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

Get a Listing of premium-only Subreddits

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

Same as getPremiumSubreddits, provided for compatibility purposes

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

Search through subreddits based on both their names and descriptions

searchSubredditsByName

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

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 ()

Follow the collection for the authenticated user

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

Unfollow the collection for the authenticated user

Collections

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

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)

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

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

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

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)

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)

Get the submission FlairTemplates on the given subreddit

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

Get the available FlairChoices for new submissions on the given subreddit

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

Get the available FlairChoices for new submissions on the current subreddit

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

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

Wiki

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

Get the subreddit WikiPage specified by name

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

Get all of the WikiPages on the subreddit wiki

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

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

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

Get a Listing of the WikiRevisions for a given wikipage

editWikiPage

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

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

Get a given subreddit's widgets

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

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

Emojis

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

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

Types

data BodyRestriction

Rules concerning the presence of self-text bodies in posts

Constructors

BodyRequired

BodyNotAllowed

NoRestriction

Instances

Eq BodyRestriction

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: BodyRestriction -> BodyRestriction -> Bool

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

Show BodyRestriction

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> BodyRestriction -> ShowS

show :: BodyRestriction -> String

showList :: [BodyRestriction] -> ShowS

Generic BodyRestriction

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

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser BodyRestriction

parseJSONList :: Value -> Parser [BodyRestriction]

type Rep BodyRestriction

Defined in Network.Reddit.Types.Subreddit

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

Mod-created requirements for posting in a subreddit

Constructors

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

Instances

Eq PostRequirements

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: PostRequirements -> PostRequirements -> Bool

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

Show PostRequirements

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> PostRequirements -> ShowS

show :: PostRequirements -> String

showList :: [PostRequirements] -> ShowS

Generic PostRequirements

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

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser PostRequirements

parseJSONList :: Value -> Parser [PostRequirements]

type Rep PostRequirements

Defined in Network.Reddit.Types.Subreddit

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

The type of item that a SubredditRule applies to

Constructors

CommentRule

LinkRule

AllRule

Instances

Eq RuleType

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: RuleType -> RuleType -> Bool

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

Ord RuleType

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

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> RuleType -> ShowS

show :: RuleType -> String

showList :: [RuleType] -> ShowS

Generic RuleType

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

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser RuleType

parseJSONList :: Value -> Parser [RuleType]

ToHttpApiData RuleType

Defined in Network.Reddit.Types.Subreddit

Methods

toUrlPiece :: RuleType -> Text

toEncodedUrlPiece :: RuleType -> Builder

toHeader :: RuleType -> ByteString

toQueryParam :: RuleType -> Text

type Rep RuleType

Defined in Network.Reddit.Types.Subreddit

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

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

Show PostedSubredditRule

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> PostedSubredditRule -> ShowS

show :: PostedSubredditRule -> String

showList :: [PostedSubredditRule] -> ShowS

Generic PostedSubredditRule

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

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser PostedSubredditRule

parseJSONList :: Value -> Parser [PostedSubredditRule]

type Rep PostedSubredditRule

Defined in Network.Reddit.Types.Subreddit

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

data NewSubredditRule

Represents a new SubredditRule that can be created by moderators

Constructors

NewSubredditRule Name RuleType Body (Maybe Text)

Instances

Eq NewSubredditRule

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: NewSubredditRule -> NewSubredditRule -> Bool

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

Show NewSubredditRule

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> NewSubredditRule -> ShowS

show :: NewSubredditRule -> String

showList :: [NewSubredditRule] -> ShowS

Generic NewSubredditRule

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

Defined in Network.Reddit.Types.Subreddit

Methods

toForm :: NewSubredditRule -> Form

type Rep NewSubredditRule

Defined in Network.Reddit.Types.Subreddit

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

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

Eq SubredditRule

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: SubredditRule -> SubredditRule -> Bool

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

Show SubredditRule

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> SubredditRule -> ShowS

show :: SubredditRule -> String

showList :: [SubredditRule] -> ShowS

Generic SubredditRule

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

Depending on the endpoint, the JSON fields are either camel- or snake-cased

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser SubredditRule

parseJSONList :: Value -> Parser [SubredditRule]

ToForm SubredditRule

Defined in Network.Reddit.Types.Subreddit

Methods

toForm :: SubredditRule -> Form

type Rep SubredditRule

Defined in Network.Reddit.Types.Subreddit

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

Unique site-wide identifier for a subreddit

Constructors

SubredditID Text

Instances

Eq SubredditID

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: SubredditID -> SubredditID -> Bool

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

Show SubredditID

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> SubredditID -> ShowS

show :: SubredditID -> String

showList :: [SubredditID] -> ShowS

Generic SubredditID

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

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser SubredditID

parseJSONList :: Value -> Parser [SubredditID]

Thing SubredditID

Defined in Network.Reddit.Types.Subreddit

Methods

fullname :: SubredditID -> Text

type Rep SubredditID

Defined in Network.Reddit.Types.Subreddit

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

data SubredditName

The name of a subreddit

Instances

Eq SubredditName

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: SubredditName -> SubredditName -> Bool

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

Show SubredditName

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> SubredditName -> ShowS

show :: SubredditName -> String

showList :: [SubredditName] -> ShowS

Generic SubredditName

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

Defined in Network.Reddit.Types.Subreddit

Methods

toJSON :: SubredditName -> Value

toEncoding :: SubredditName -> Encoding

toJSONList :: [SubredditName] -> Value

toEncodingList :: [SubredditName] -> Encoding

FromJSON SubredditName

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser SubredditName

parseJSONList :: Value -> Parser [SubredditName]

ToHttpApiData SubredditName

Defined in Network.Reddit.Types.Subreddit

Methods

toUrlPiece :: SubredditName -> Text

toEncodedUrlPiece :: SubredditName -> Builder

toHeader :: SubredditName -> ByteString

toQueryParam :: SubredditName -> Text

type Rep SubredditName

Defined in Network.Reddit.Types.Subreddit

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

data Subreddit

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

Constructors

Subreddit SubredditID SubredditName Title UTCTime Body (Maybe Body) Body Integer Bool (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) Bool

Instances

Eq Subreddit

Defined in Network.Reddit.Types.Subreddit

Methods

(==) :: Subreddit -> Subreddit -> Bool

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

Show Subreddit

Defined in Network.Reddit.Types.Subreddit

Methods

showsPrec :: Int -> Subreddit -> ShowS

show :: Subreddit -> String

showList :: [Subreddit] -> ShowS

Generic Subreddit

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

Defined in Network.Reddit.Types.Subreddit

Methods

parseJSON :: Value -> Parser Subreddit

parseJSONList :: Value -> Parser [Subreddit]

Paginable Subreddit

Defined in Network.Reddit.Types.Subreddit

Associated Types

type PaginateOptions Subreddit

type PaginateThing Subreddit

Methods

defaultOpts :: PaginateOptions Subreddit

getFullname :: Subreddit -> PaginateThing Subreddit

optsToForm :: PaginateOptions Subreddit -> Form

type Rep Subreddit

Defined in Network.Reddit.Types.Subreddit

type Rep Subreddit = D1 ('MetaData "Subreddit" "Network.Reddit.Types.Subreddit" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)) :*: (S1 ('MetaSel ('Just "descriptionHTML") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Body)) :*: S1 ('MetaSel ('Just "publicDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Body)))) :*: (((S1 ('MetaSel ('Just "subscribers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "userIsBanned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "userIsModerator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "userIsSubscriber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "canAssignLinkFlair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "canAssignUserFlair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "quarantine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))))

type PaginateOptions Subreddit

Defined in Network.Reddit.Types.Subreddit

type PaginateOptions Subreddit = ()

type PaginateThing Subreddit

Defined in Network.Reddit.Types.Subreddit

type PaginateThing Subreddit = SubredditID

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

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

Foreground color for v2 flair

Constructors

Dark

Light

Instances

Eq ForegroundColor

Defined in Network.Reddit.Types.Flair

Methods

(==) :: ForegroundColor -> ForegroundColor -> Bool

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

Show ForegroundColor

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> ForegroundColor -> ShowS

show :: ForegroundColor -> String

showList :: [ForegroundColor] -> ShowS

Generic ForegroundColor

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

Defined in Network.Reddit.Types.Flair

Methods

toJSON :: ForegroundColor -> Value

toEncoding :: ForegroundColor -> Encoding

toJSONList :: [ForegroundColor] -> Value

toEncodingList :: [ForegroundColor] -> Encoding

FromJSON ForegroundColor

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser ForegroundColor

parseJSONList :: Value -> Parser [ForegroundColor]

ToHttpApiData ForegroundColor

Defined in Network.Reddit.Types.Flair

Methods

toUrlPiece :: ForegroundColor -> Text

toEncodedUrlPiece :: ForegroundColor -> Builder

toHeader :: ForegroundColor -> ByteString

toQueryParam :: ForegroundColor -> Text

type Rep ForegroundColor

Defined in Network.Reddit.Types.Flair

type Rep ForegroundColor = D1 ('MetaData "ForegroundColor" "Network.Reddit.Types.Flair" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Dark" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Light" 'PrefixI 'False) (U1 :: Type -> Type))

data FlairContent

The type of content that is allowed in a flair template

Constructors

AllContent

EmojisOnly

TextOnly

Instances

Eq FlairContent

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairContent -> FlairContent -> Bool

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

Show FlairContent

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairContent -> ShowS

show :: FlairContent -> String

showList :: [FlairContent] -> ShowS

Generic FlairContent

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairContent

parseJSONList :: Value -> Parser [FlairContent]

ToHttpApiData FlairContent

Defined in Network.Reddit.Types.Flair

Methods

toUrlPiece :: FlairContent -> Text

toEncodedUrlPiece :: FlairContent -> Builder

toHeader :: FlairContent -> ByteString

toQueryParam :: FlairContent -> Text

type Rep FlairContent

Defined in Network.Reddit.Types.Flair

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

The type of flair, when creating a new template

Constructors

UserFlairType

SubmissionFlairType

Instances

Eq FlairType

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairType -> FlairType -> Bool

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

Show FlairType

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairType -> ShowS

show :: FlairType -> String

showList :: [FlairType] -> ShowS

Generic FlairType

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

Defined in Network.Reddit.Types.Flair

Methods

toUrlPiece :: FlairType -> Text

toEncodedUrlPiece :: FlairType -> Builder

toHeader :: FlairType -> ByteString

toQueryParam :: FlairType -> Text

type Rep FlairType

Defined in Network.Reddit.Types.Flair

type Rep FlairType = D1 ('MetaData "FlairType" "Network.Reddit.Types.Flair" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "UserFlairType" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SubmissionFlairType" 'PrefixI 'False) (U1 :: Type -> Type))

data FlairResult

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

Eq FlairResult

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairResult -> FlairResult -> Bool

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

Show FlairResult

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairResult -> ShowS

show :: FlairResult -> String

showList :: [FlairResult] -> ShowS

Generic FlairResult

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairResult

parseJSONList :: Value -> Parser [FlairResult]

type Rep FlairResult

Defined in Network.Reddit.Types.Flair

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

Select a FlairChoice for a submission or for the user

Constructors

FlairSelection FlairChoice (Maybe Text) SubredditName

Instances

Eq FlairSelection

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairSelection -> FlairSelection -> Bool

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

Show FlairSelection

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairSelection -> ShowS

show :: FlairSelection -> String

showList :: [FlairSelection] -> ShowS

Generic FlairSelection

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

Defined in Network.Reddit.Types.Flair

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

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

Instances

Show CurrentUserFlair

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> CurrentUserFlair -> ShowS

show :: CurrentUserFlair -> String

showList :: [CurrentUserFlair] -> ShowS

Generic CurrentUserFlair

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser CurrentUserFlair

parseJSONList :: Value -> Parser [CurrentUserFlair]

type Rep CurrentUserFlair

Defined in Network.Reddit.Types.Flair

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

data UserFlair

Flair that is currently assigned to a user

Constructors

UserFlair (Maybe FlairText) (Maybe CSSClass)

Instances

Eq UserFlair

Defined in Network.Reddit.Types.Flair

Methods

(==) :: UserFlair -> UserFlair -> Bool

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

Show UserFlair

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> UserFlair -> ShowS

show :: UserFlair -> String

showList :: [UserFlair] -> ShowS

Generic UserFlair

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser UserFlair

parseJSONList :: Value -> Parser [UserFlair]

type Rep UserFlair

Defined in Network.Reddit.Types.Flair

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

Instances

Show FlairChoiceList

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairChoiceList -> ShowS

show :: FlairChoiceList -> String

showList :: [FlairChoiceList] -> ShowS

Generic FlairChoiceList

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairChoiceList

parseJSONList :: Value -> Parser [FlairChoiceList]

type Rep FlairChoiceList

Defined in Network.Reddit.Types.Flair

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

data FlairChoice

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

Eq FlairChoice

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairChoice -> FlairChoice -> Bool

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

Show FlairChoice

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairChoice -> ShowS

show :: FlairChoice -> String

showList :: [FlairChoice] -> ShowS

Generic FlairChoice

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairChoice

parseJSONList :: Value -> Parser [FlairChoice]

type Rep FlairChoice

Defined in Network.Reddit.Types.Flair

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

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

Eq PostedFlairTemplate

Defined in Network.Reddit.Types.Flair

Methods

(==) :: PostedFlairTemplate -> PostedFlairTemplate -> Bool

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

Show PostedFlairTemplate

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> PostedFlairTemplate -> ShowS

show :: PostedFlairTemplate -> String

showList :: [PostedFlairTemplate] -> ShowS

Generic PostedFlairTemplate

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

Defined in Network.Reddit.Types.Flair

Methods

toForm :: PostedFlairTemplate -> Form

type Rep PostedFlairTemplate

Defined in Network.Reddit.Types.Flair

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

data FlairTemplate

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

Eq FlairTemplate

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairTemplate -> FlairTemplate -> Bool

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

Show FlairTemplate

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairTemplate -> ShowS

show :: FlairTemplate -> String

showList :: [FlairTemplate] -> ShowS

Generic FlairTemplate

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairTemplate

parseJSONList :: Value -> Parser [FlairTemplate]

ToForm FlairTemplate

Defined in Network.Reddit.Types.Flair

Methods

toForm :: FlairTemplate -> Form

type Rep FlairTemplate

Defined in Network.Reddit.Types.Flair

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

An identifier for a FlairTemplate

data FlairList

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

Eq FlairList

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairList -> FlairList -> Bool

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

Show FlairList

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairList -> ShowS

show :: FlairList -> String

showList :: [FlairList] -> ShowS

Generic FlairList

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairList

parseJSONList :: Value -> Parser [FlairList]

type Rep FlairList

Defined in Network.Reddit.Types.Flair

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

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

Constructors

AssignedFlair Username (Maybe FlairText) (Maybe CSSClass)

Instances

Eq AssignedFlair

Defined in Network.Reddit.Types.Flair

Methods

(==) :: AssignedFlair -> AssignedFlair -> Bool

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

Show AssignedFlair

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> AssignedFlair -> ShowS

show :: AssignedFlair -> String

showList :: [AssignedFlair] -> ShowS

Generic AssignedFlair

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

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser AssignedFlair

parseJSONList :: Value -> Parser [AssignedFlair]

Paginable AssignedFlair

Defined in Network.Reddit.Types.Flair

Associated Types

type PaginateOptions AssignedFlair

type PaginateThing AssignedFlair

Methods

defaultOpts :: PaginateOptions AssignedFlair

getFullname :: AssignedFlair -> PaginateThing AssignedFlair

optsToForm :: PaginateOptions AssignedFlair -> Form

type Rep AssignedFlair

Defined in Network.Reddit.Types.Flair

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

Defined in Network.Reddit.Types.Flair

type PaginateOptions AssignedFlair = ()

type PaginateThing AssignedFlair

Defined in Network.Reddit.Types.Flair

type PaginateThing AssignedFlair = Text

type CSSClass = Text

CSS class for flair

data FlairText

The text displayed by the FlairTemplate

Instances

Eq FlairText

Defined in Network.Reddit.Types.Flair

Methods

(==) :: FlairText -> FlairText -> Bool

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

Show FlairText

Defined in Network.Reddit.Types.Flair

Methods

showsPrec :: Int -> FlairText -> ShowS

show :: FlairText -> String

showList :: [FlairText] -> ShowS

Generic FlairText

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

Defined in Network.Reddit.Types.Flair

Methods

(<>) :: FlairText -> FlairText -> FlairText

sconcat :: NonEmpty FlairText -> FlairText

stimes :: Integral b => b -> FlairText -> FlairText

Monoid FlairText

Defined in Network.Reddit.Types.Flair

Methods

mempty :: FlairText

mappend :: FlairText -> FlairText -> FlairText

mconcat :: [FlairText] -> FlairText

ToJSON FlairText

Defined in Network.Reddit.Types.Flair

Methods

toJSON :: FlairText -> Value

toEncoding :: FlairText -> Encoding

toJSONList :: [FlairText] -> Value

toEncodingList :: [FlairText] -> Encoding

FromJSON FlairText

Defined in Network.Reddit.Types.Flair

Methods

parseJSON :: Value -> Parser FlairText

parseJSONList :: Value -> Parser [FlairText]

ToHttpApiData FlairText

Defined in Network.Reddit.Types.Flair

Methods

toUrlPiece :: FlairText -> Text

toEncodedUrlPiece :: FlairText -> Builder

toHeader :: FlairText -> ByteString

toQueryParam :: FlairText -> Text

type Rep FlairText

Defined in Network.Reddit.Types.Flair

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

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

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

flairlistToListing :: FlairList -> Listing UserID AssignedFlair

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

defaultFlairTemplate :: FlairTemplate

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

data EmojiName

The name of an individual Emoji

Instances

Eq EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

(==) :: EmojiName -> EmojiName -> Bool

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

Show EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

showsPrec :: Int -> EmojiName -> ShowS

show :: EmojiName -> String

showList :: [EmojiName] -> ShowS

Generic EmojiName

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

Defined in Network.Reddit.Types.Emoji

Methods

(<>) :: EmojiName -> EmojiName -> EmojiName

sconcat :: NonEmpty EmojiName -> EmojiName

stimes :: Integral b => b -> EmojiName -> EmojiName

Monoid EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

mempty :: EmojiName

mappend :: EmojiName -> EmojiName -> EmojiName

mconcat :: [EmojiName] -> EmojiName

FromJSON EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

parseJSON :: Value -> Parser EmojiName

parseJSONList :: Value -> Parser [EmojiName]

ToHttpApiData EmojiName

Defined in Network.Reddit.Types.Emoji

Methods

toUrlPiece :: EmojiName -> Text

toEncodedUrlPiece :: EmojiName -> Builder

toHeader :: EmojiName -> ByteString

toQueryParam :: EmojiName -> Text

type Rep EmojiName

Defined in Network.Reddit.Types.Emoji

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

data Emoji

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

Eq Emoji

Defined in Network.Reddit.Types.Emoji

Methods

(==) :: Emoji -> Emoji -> Bool

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

Show Emoji

Defined in Network.Reddit.Types.Emoji

Methods

showsPrec :: Int -> Emoji -> ShowS

show :: Emoji -> String

showList :: [Emoji] -> ShowS

Generic Emoji

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

Defined in Network.Reddit.Types.Emoji

Methods

parseJSON :: Value -> Parser Emoji

parseJSONList :: Value -> Parser [Emoji]

ToForm Emoji

Defined in Network.Reddit.Types.Emoji

Methods

toForm :: Emoji -> Form

type Rep Emoji

Defined in Network.Reddit.Types.Emoji

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

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

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

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

data TextAreaWidget

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

Constructors

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

Instances

Eq TextAreaWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: TextAreaWidget -> TextAreaWidget -> Bool

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

Show TextAreaWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> TextAreaWidget -> ShowS

show :: TextAreaWidget -> String

showList :: [TextAreaWidget] -> ShowS

Generic TextAreaWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: TextAreaWidget -> Value

toEncoding :: TextAreaWidget -> Encoding

toJSONList :: [TextAreaWidget] -> Value

toEncodingList :: [TextAreaWidget] -> Encoding

FromJSON TextAreaWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser TextAreaWidget

parseJSONList :: Value -> Parser [TextAreaWidget]

type Rep TextAreaWidget

Defined in Network.Reddit.Types.Widget

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

Display style for a RulesWidget

Constructors

FullDisplay

CompactDisplay

Instances

Eq RulesDisplay

Defined in Network.Reddit.Types.Widget

Methods

(==) :: RulesDisplay -> RulesDisplay -> Bool

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

Show RulesDisplay

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> RulesDisplay -> ShowS

show :: RulesDisplay -> String

showList :: [RulesDisplay] -> ShowS

Generic RulesDisplay

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: RulesDisplay -> Value

toEncoding :: RulesDisplay -> Encoding

toJSONList :: [RulesDisplay] -> Value

toEncodingList :: [RulesDisplay] -> Encoding

FromJSON RulesDisplay

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser RulesDisplay

parseJSONList :: Value -> Parser [RulesDisplay]

type Rep RulesDisplay

Defined in Network.Reddit.Types.Widget

type Rep RulesDisplay = D1 ('MetaData "RulesDisplay" "Network.Reddit.Types.Widget" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "FullDisplay" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CompactDisplay" 'PrefixI 'False) (U1 :: Type -> Type))

data RulesWidget

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

Eq RulesWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: RulesWidget -> RulesWidget -> Bool

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

Show RulesWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> RulesWidget -> ShowS

show :: RulesWidget -> String

showList :: [RulesWidget] -> ShowS

Generic RulesWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: RulesWidget -> Value

toEncoding :: RulesWidget -> Encoding

toJSONList :: [RulesWidget] -> Value

toEncodingList :: [RulesWidget] -> Encoding

FromJSON RulesWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser RulesWidget

parseJSONList :: Value -> Parser [RulesWidget]

type Rep RulesWidget

Defined in Network.Reddit.Types.Widget

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

The display orientation for PostFlairWidgets

Constructors

CloudDisplay

ListDisplay

Instances

Eq PostFlairWidgetDisplay

Defined in Network.Reddit.Types.Widget

Methods

(==) :: PostFlairWidgetDisplay -> PostFlairWidgetDisplay -> Bool

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

Show PostFlairWidgetDisplay

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> PostFlairWidgetDisplay -> ShowS

show :: PostFlairWidgetDisplay -> String

showList :: [PostFlairWidgetDisplay] -> ShowS

Generic PostFlairWidgetDisplay

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: PostFlairWidgetDisplay -> Value

toEncoding :: PostFlairWidgetDisplay -> Encoding

toJSONList :: [PostFlairWidgetDisplay] -> Value

toEncodingList :: [PostFlairWidgetDisplay] -> Encoding

FromJSON PostFlairWidgetDisplay

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser PostFlairWidgetDisplay

parseJSONList :: Value -> Parser [PostFlairWidgetDisplay]

type Rep PostFlairWidgetDisplay

Defined in Network.Reddit.Types.Widget

type Rep PostFlairWidgetDisplay = D1 ('MetaData "PostFlairWidgetDisplay" "Network.Reddit.Types.Widget" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "CloudDisplay" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListDisplay" 'PrefixI 'False) (U1 :: Type -> Type))

data PostFlairInfo

Information about submission flair templates in a PostFlairWidget

Constructors

PostFlairInfo FlairID Text ForegroundColor RGBText

Instances

Eq PostFlairInfo

Defined in Network.Reddit.Types.Widget

Methods

(==) :: PostFlairInfo -> PostFlairInfo -> Bool

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

Show PostFlairInfo

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> PostFlairInfo -> ShowS

show :: PostFlairInfo -> String

showList :: [PostFlairInfo] -> ShowS

Generic PostFlairInfo

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

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser PostFlairInfo

parseJSONList :: Value -> Parser [PostFlairInfo]

type Rep PostFlairInfo

Defined in Network.Reddit.Types.Widget

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

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

Eq PostFlairWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: PostFlairWidget -> PostFlairWidget -> Bool

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

Show PostFlairWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> PostFlairWidget -> ShowS

show :: PostFlairWidget -> String

showList :: [PostFlairWidget] -> ShowS

Generic PostFlairWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: PostFlairWidget -> Value

toEncoding :: PostFlairWidget -> Encoding

toJSONList :: [PostFlairWidget] -> Value

toEncodingList :: [PostFlairWidget] -> Encoding

FromJSON PostFlairWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser PostFlairWidget

parseJSONList :: Value -> Parser [PostFlairWidget]

type Rep PostFlairWidget

Defined in Network.Reddit.Types.Widget

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

Information about a moderator as displayed in a ModeratorsWidget

Constructors

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

Instances

Eq ModInfo

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ModInfo -> ModInfo -> Bool

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

Show ModInfo

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ModInfo -> ShowS

show :: ModInfo -> String

showList :: [ModInfo] -> ShowS

Generic ModInfo

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ModInfo -> Value

toEncoding :: ModInfo -> Encoding

toJSONList :: [ModInfo] -> Value

toEncodingList :: [ModInfo] -> Encoding

FromJSON ModInfo

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ModInfo

parseJSONList :: Value -> Parser [ModInfo]

type Rep ModInfo

Defined in Network.Reddit.Types.Widget

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

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

Eq ModeratorsWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ModeratorsWidget -> ModeratorsWidget -> Bool

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

Show ModeratorsWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ModeratorsWidget -> ShowS

show :: ModeratorsWidget -> String

showList :: [ModeratorsWidget] -> ShowS

Generic ModeratorsWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ModeratorsWidget -> Value

toEncoding :: ModeratorsWidget -> Encoding

toJSONList :: [ModeratorsWidget] -> Value

toEncodingList :: [ModeratorsWidget] -> Encoding

FromJSON ModeratorsWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ModeratorsWidget

parseJSONList :: Value -> Parser [ModeratorsWidget]

type Rep ModeratorsWidget

Defined in Network.Reddit.Types.Widget

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

A link in a MenuWidget or Submenu

Constructors

MenuLink Text URL

Instances

Eq MenuLink

Defined in Network.Reddit.Types.Widget

Methods

(==) :: MenuLink -> MenuLink -> Bool

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

Show MenuLink

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> MenuLink -> ShowS

show :: MenuLink -> String

showList :: [MenuLink] -> ShowS

Generic MenuLink

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: MenuLink -> Value

toEncoding :: MenuLink -> Encoding

toJSONList :: [MenuLink] -> Value

toEncodingList :: [MenuLink] -> Encoding

FromJSON MenuLink

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser MenuLink

parseJSONList :: Value -> Parser [MenuLink]

type Rep MenuLink

Defined in Network.Reddit.Types.Widget

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

A submenu child in a MenuWidget which contains MenuLinks

Constructors

Submenu (Seq MenuLink) Text

Instances

Eq Submenu

Defined in Network.Reddit.Types.Widget

Methods

(==) :: Submenu -> Submenu -> Bool

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

Show Submenu

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> Submenu -> ShowS

show :: Submenu -> String

showList :: [Submenu] -> ShowS

Generic Submenu

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: Submenu -> Value

toEncoding :: Submenu -> Encoding

toJSONList :: [Submenu] -> Value

toEncodingList :: [Submenu] -> Encoding

FromJSON Submenu

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser Submenu

parseJSONList :: Value -> Parser [Submenu]

type Rep Submenu

Defined in Network.Reddit.Types.Widget

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

A child widget in a MenuWidget

Constructors

SubmenuChild Submenu

MenuLinkChild MenuLink

Instances

Eq MenuChild

Defined in Network.Reddit.Types.Widget

Methods

(==) :: MenuChild -> MenuChild -> Bool

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

Show MenuChild

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> MenuChild -> ShowS

show :: MenuChild -> String

showList :: [MenuChild] -> ShowS

Generic MenuChild

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: MenuChild -> Value

toEncoding :: MenuChild -> Encoding

toJSONList :: [MenuChild] -> Value

toEncodingList :: [MenuChild] -> Encoding

FromJSON MenuChild

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser MenuChild

parseJSONList :: Value -> Parser [MenuChild]

type Rep MenuChild

Defined in Network.Reddit.Types.Widget

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

A widget representing a menu

Constructors

MenuWidget (Maybe WidgetID) (Seq MenuChild)

Instances

Eq MenuWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: MenuWidget -> MenuWidget -> Bool

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

Show MenuWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> MenuWidget -> ShowS

show :: MenuWidget -> String

showList :: [MenuWidget] -> ShowS

Generic MenuWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: MenuWidget -> Value

toEncoding :: MenuWidget -> Encoding

toJSONList :: [MenuWidget] -> Value

toEncodingList :: [MenuWidget] -> Encoding

FromJSON MenuWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser MenuWidget

parseJSONList :: Value -> Parser [MenuWidget]

type Rep MenuWidget

Defined in Network.Reddit.Types.Widget

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

An individual image in an ImageWidget

Constructors

Image Integer Integer UploadURL (Maybe URL)

Instances

Eq Image

Defined in Network.Reddit.Types.Widget

Methods

(==) :: Image -> Image -> Bool

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

Show Image

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> Image -> ShowS

show :: Image -> String

showList :: [Image] -> ShowS

Generic Image

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: Image -> Value

toEncoding :: Image -> Encoding

toJSONList :: [Image] -> Value

toEncodingList :: [Image] -> Encoding

FromJSON Image

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser Image

parseJSONList :: Value -> Parser [Image]

type Rep Image

Defined in Network.Reddit.Types.Widget

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

A widget composed of various Images

Constructors

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

Instances

Eq ImageWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ImageWidget -> ImageWidget -> Bool

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

Show ImageWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ImageWidget -> ShowS

show :: ImageWidget -> String

showList :: [ImageWidget] -> ShowS

Generic ImageWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ImageWidget -> Value

toEncoding :: ImageWidget -> Encoding

toJSONList :: [ImageWidget] -> Value

toEncodingList :: [ImageWidget] -> Encoding

FromJSON ImageWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ImageWidget

parseJSONList :: Value -> Parser [ImageWidget]

type Rep ImageWidget

Defined in Network.Reddit.Types.Widget

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

An ID card displaying information about the subreddit

Constructors

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

Instances

Eq IDCardWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: IDCardWidget -> IDCardWidget -> Bool

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

Show IDCardWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> IDCardWidget -> ShowS

show :: IDCardWidget -> String

showList :: [IDCardWidget] -> ShowS

Generic IDCardWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: IDCardWidget -> Value

toEncoding :: IDCardWidget -> Encoding

toJSONList :: [IDCardWidget] -> Value

toEncodingList :: [IDCardWidget] -> Encoding

FromJSON IDCardWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser IDCardWidget

parseJSONList :: Value -> Parser [IDCardWidget]

type Rep IDCardWidget

Defined in Network.Reddit.Types.Widget

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

Image data that belongs to a CustomWidget

Constructors

ImageData Name Int Int UploadURL

Instances

Eq ImageData

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ImageData -> ImageData -> Bool

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

Show ImageData

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ImageData -> ShowS

show :: ImageData -> String

showList :: [ImageData] -> ShowS

Generic ImageData

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ImageData -> Value

toEncoding :: ImageData -> Encoding

toJSONList :: [ImageData] -> Value

toEncodingList :: [ImageData] -> Encoding

FromJSON ImageData

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ImageData

parseJSONList :: Value -> Parser [ImageData]

type Rep ImageData

Defined in Network.Reddit.Types.Widget

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

A custom widget

Constructors

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

Instances

Eq CustomWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: CustomWidget -> CustomWidget -> Bool

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

Show CustomWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> CustomWidget -> ShowS

show :: CustomWidget -> String

showList :: [CustomWidget] -> ShowS

Generic CustomWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: CustomWidget -> Value

toEncoding :: CustomWidget -> Encoding

toJSONList :: [CustomWidget] -> Value

toEncodingList :: [CustomWidget] -> Encoding

FromJSON CustomWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser CustomWidget

parseJSONList :: Value -> Parser [CustomWidget]

type Rep CustomWidget

Defined in Network.Reddit.Types.Widget

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

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

Eq CommunityInfo

Defined in Network.Reddit.Types.Widget

Methods

(==) :: CommunityInfo -> CommunityInfo -> Bool

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

Show CommunityInfo

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> CommunityInfo -> ShowS

show :: CommunityInfo -> String

showList :: [CommunityInfo] -> ShowS

Generic CommunityInfo

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: CommunityInfo -> Value

toEncoding :: CommunityInfo -> Encoding

toJSONList :: [CommunityInfo] -> Value

toEncodingList :: [CommunityInfo] -> Encoding

FromJSON CommunityInfo

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser CommunityInfo

parseJSONList :: Value -> Parser [CommunityInfo]

type Rep CommunityInfo

Defined in Network.Reddit.Types.Widget

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

A widget listing related subreddits

Constructors

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

Instances

Eq CommunityListWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: CommunityListWidget -> CommunityListWidget -> Bool

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

Show CommunityListWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> CommunityListWidget -> ShowS

show :: CommunityListWidget -> String

showList :: [CommunityListWidget] -> ShowS

Generic CommunityListWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: CommunityListWidget -> Value

toEncoding :: CommunityListWidget -> Encoding

toJSONList :: [CommunityListWidget] -> Value

toEncodingList :: [CommunityListWidget] -> Encoding

FromJSON CommunityListWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser CommunityListWidget

parseJSONList :: Value -> Parser [CommunityListWidget]

type Rep CommunityListWidget

Defined in Network.Reddit.Types.Widget

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

Configuration options for a CalendarWidget

Constructors

CalendarConfig Word Bool Bool Bool Bool Bool

Instances

Eq CalendarConfig

Defined in Network.Reddit.Types.Widget

Methods

(==) :: CalendarConfig -> CalendarConfig -> Bool

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

Show CalendarConfig

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> CalendarConfig -> ShowS

show :: CalendarConfig -> String

showList :: [CalendarConfig] -> ShowS

Generic CalendarConfig

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: CalendarConfig -> Value

toEncoding :: CalendarConfig -> Encoding

toJSONList :: [CalendarConfig] -> Value

toEncodingList :: [CalendarConfig] -> Encoding

FromJSON CalendarConfig

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser CalendarConfig

parseJSONList :: Value -> Parser [CalendarConfig]

type Rep CalendarConfig

Defined in Network.Reddit.Types.Widget

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

A widget representing a calendar

Constructors

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

Instances

Eq CalendarWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: CalendarWidget -> CalendarWidget -> Bool

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

Show CalendarWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> CalendarWidget -> ShowS

show :: CalendarWidget -> String

showList :: [CalendarWidget] -> ShowS

Generic CalendarWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: CalendarWidget -> Value

toEncoding :: CalendarWidget -> Encoding

toJSONList :: [CalendarWidget] -> Value

toEncodingList :: [CalendarWidget] -> Encoding

FromJSON CalendarWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser CalendarWidget

parseJSONList :: Value -> Parser [CalendarWidget]

type Rep CalendarWidget

Defined in Network.Reddit.Types.Widget

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

The state of a TextButton when hovering over it

Constructors

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

Instances

Eq TextHover

Defined in Network.Reddit.Types.Widget

Methods

(==) :: TextHover -> TextHover -> Bool

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

Show TextHover

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> TextHover -> ShowS

show :: TextHover -> String

showList :: [TextHover] -> ShowS

Generic TextHover

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: TextHover -> Value

toEncoding :: TextHover -> Encoding

toJSONList :: [TextHover] -> Value

toEncodingList :: [TextHover] -> Encoding

FromJSON TextHover

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser TextHover

parseJSONList :: Value -> Parser [TextHover]

type Rep TextHover

Defined in Network.Reddit.Types.Widget

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

The state of an ImageButton when hovering over it

Constructors

ImageHover UploadURL (Maybe Integer) (Maybe Integer)

Instances

Eq ImageHover

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ImageHover -> ImageHover -> Bool

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

Show ImageHover

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ImageHover -> ShowS

show :: ImageHover -> String

showList :: [ImageHover] -> ShowS

Generic ImageHover

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ImageHover -> Value

toEncoding :: ImageHover -> Encoding

toJSONList :: [ImageHover] -> Value

toEncodingList :: [ImageHover] -> Encoding

FromJSON ImageHover

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ImageHover

parseJSONList :: Value -> Parser [ImageHover]

type Rep ImageHover

Defined in Network.Reddit.Types.Widget

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

The state of the Button when hovering over it

Constructors

ImageButtonHover ImageHover

TextButtonHover TextHover

Instances

Eq ButtonHover

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ButtonHover -> ButtonHover -> Bool

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

Show ButtonHover

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ButtonHover -> ShowS

show :: ButtonHover -> String

showList :: [ButtonHover] -> ShowS

Generic ButtonHover

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ButtonHover -> Value

toEncoding :: ButtonHover -> Encoding

toJSONList :: [ButtonHover] -> Value

toEncodingList :: [ButtonHover] -> Encoding

FromJSON ButtonHover

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ButtonHover

parseJSONList :: Value -> Parser [ButtonHover]

type Rep ButtonHover

Defined in Network.Reddit.Types.Widget

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

Data for a TextButton

Constructors

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

Instances

Eq ButtonText

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ButtonText -> ButtonText -> Bool

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

Show ButtonText

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ButtonText -> ShowS

show :: ButtonText -> String

showList :: [ButtonText] -> ShowS

Generic ButtonText

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ButtonText -> Value

toEncoding :: ButtonText -> Encoding

toJSONList :: [ButtonText] -> Value

toEncodingList :: [ButtonText] -> Encoding

FromJSON ButtonText

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ButtonText

parseJSONList :: Value -> Parser [ButtonText]

type Rep ButtonText

Defined in Network.Reddit.Types.Widget

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

Data for an ImageButton

Constructors

ButtonImage ShortName UploadURL URL Int Int (Maybe ButtonHover)

Instances

Eq ButtonImage

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ButtonImage -> ButtonImage -> Bool

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

Show ButtonImage

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ButtonImage -> ShowS

show :: ButtonImage -> String

showList :: [ButtonImage] -> ShowS

Generic ButtonImage

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ButtonImage -> Value

toEncoding :: ButtonImage -> Encoding

toJSONList :: [ButtonImage] -> Value

toEncodingList :: [ButtonImage] -> Encoding

FromJSON ButtonImage

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ButtonImage

parseJSONList :: Value -> Parser [ButtonImage]

type Rep ButtonImage

Defined in Network.Reddit.Types.Widget

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

An individual button in a ButtonWidget

Constructors

ImageButton ButtonImage

TextButton ButtonText

Instances

Eq Button

Defined in Network.Reddit.Types.Widget

Methods

(==) :: Button -> Button -> Bool

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

Show Button

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> Button -> ShowS

show :: Button -> String

showList :: [Button] -> ShowS

Generic Button

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: Button -> Value

toEncoding :: Button -> Encoding

toJSONList :: [Button] -> Value

toEncodingList :: [Button] -> Encoding

FromJSON Button

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser Button

parseJSONList :: Value -> Parser [Button]

type Rep Button

Defined in Network.Reddit.Types.Widget

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

A widget containing buttons

Constructors

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

Instances

Eq ButtonWidget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ButtonWidget -> ButtonWidget -> Bool

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

Show ButtonWidget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ButtonWidget -> ShowS

show :: ButtonWidget -> String

showList :: [ButtonWidget] -> ShowS

Generic ButtonWidget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ButtonWidget -> Value

toEncoding :: ButtonWidget -> Encoding

toJSONList :: [ButtonWidget] -> Value

toEncodingList :: [ButtonWidget] -> Encoding

FromJSON ButtonWidget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ButtonWidget

parseJSONList :: Value -> Parser [ButtonWidget]

type Rep ButtonWidget

Defined in Network.Reddit.Types.Widget

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

Style options for an individual widget

Constructors

WidgetStyles (Maybe RGBText) (Maybe RGBText)

Instances

Eq WidgetStyles

Defined in Network.Reddit.Types.Widget

Methods

(==) :: WidgetStyles -> WidgetStyles -> Bool

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

Show WidgetStyles

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> WidgetStyles -> ShowS

show :: WidgetStyles -> String

showList :: [WidgetStyles] -> ShowS

Generic WidgetStyles

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: WidgetStyles -> Value

toEncoding :: WidgetStyles -> Encoding

toJSONList :: [WidgetStyles] -> Value

toEncodingList :: [WidgetStyles] -> Encoding

FromJSON WidgetStyles

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser WidgetStyles

parseJSONList :: Value -> Parser [WidgetStyles]

type Rep WidgetStyles

Defined in Network.Reddit.Types.Widget

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

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

Instances

Eq ShortName

Defined in Network.Reddit.Types.Widget

Methods

(==) :: ShortName -> ShortName -> Bool

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

Show ShortName

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> ShortName -> ShowS

show :: ShortName -> String

showList :: [ShortName] -> ShowS

Generic ShortName

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: ShortName -> Value

toEncoding :: ShortName -> Encoding

toJSONList :: [ShortName] -> Value

toEncodingList :: [ShortName] -> Encoding

FromJSON ShortName

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser ShortName

parseJSONList :: Value -> Parser [ShortName]

type Rep ShortName

Defined in Network.Reddit.Types.Widget

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

data WidgetSection

The section in which certain Widgets appear

Constructors

Topbar

Sidebar

Instances

Eq WidgetSection

Defined in Network.Reddit.Types.Widget

Methods

(==) :: WidgetSection -> WidgetSection -> Bool

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

Show WidgetSection

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> WidgetSection -> ShowS

show :: WidgetSection -> String

showList :: [WidgetSection] -> ShowS

Generic WidgetSection

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

Defined in Network.Reddit.Types.Widget

Methods

toUrlPiece :: WidgetSection -> Text

toEncodedUrlPiece :: WidgetSection -> Builder

toHeader :: WidgetSection -> ByteString

toQueryParam :: WidgetSection -> Text

type Rep WidgetSection

Defined in Network.Reddit.Types.Widget

type Rep WidgetSection = D1 ('MetaData "WidgetSection" "Network.Reddit.Types.Widget" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Topbar" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sidebar" 'PrefixI 'False) (U1 :: Type -> Type))

newtype WidgetID

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

Eq WidgetID

Defined in Network.Reddit.Types.Widget

Methods

(==) :: WidgetID -> WidgetID -> Bool

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

Show WidgetID

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> WidgetID -> ShowS

show :: WidgetID -> String

showList :: [WidgetID] -> ShowS

Generic WidgetID

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: WidgetID -> Value

toEncoding :: WidgetID -> Encoding

toJSONList :: [WidgetID] -> Value

toEncodingList :: [WidgetID] -> Encoding

FromJSON WidgetID

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser WidgetID

parseJSONList :: Value -> Parser [WidgetID]

ToHttpApiData WidgetID

Defined in Network.Reddit.Types.Widget

Methods

toUrlPiece :: WidgetID -> Text

toEncodedUrlPiece :: WidgetID -> Builder

toHeader :: WidgetID -> ByteString

toQueryParam :: WidgetID -> Text

type Rep WidgetID

Defined in Network.Reddit.Types.Widget

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

data Widget

Represents one of various kinds of widgets

Constructors

Buttons ButtonWidget

Calendar CalendarWidget

CommunityList CommunityListWidget

Custom CustomWidget

IDCard IDCardWidget

Images ImageWidget

Moderators ModeratorsWidget

Menu MenuWidget

PostFlair PostFlairWidget

Rules RulesWidget

TextArea TextAreaWidget

Instances

Eq Widget

Defined in Network.Reddit.Types.Widget

Methods

(==) :: Widget -> Widget -> Bool

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

Show Widget

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> Widget -> ShowS

show :: Widget -> String

showList :: [Widget] -> ShowS

Generic Widget

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

Defined in Network.Reddit.Types.Widget

Methods

toJSON :: Widget -> Value

toEncoding :: Widget -> Encoding

toJSONList :: [Widget] -> Value

toEncodingList :: [Widget] -> Encoding

FromJSON Widget

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser Widget

parseJSONList :: Value -> Parser [Widget]

type Rep Widget

Defined in Network.Reddit.Types.Widget

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

data SubredditWidgets

An organized collection of a subreddit's widgets

Constructors

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

Instances

Eq SubredditWidgets

Defined in Network.Reddit.Types.Widget

Methods

(==) :: SubredditWidgets -> SubredditWidgets -> Bool

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

Show SubredditWidgets

Defined in Network.Reddit.Types.Widget

Methods

showsPrec :: Int -> SubredditWidgets -> ShowS

show :: SubredditWidgets -> String

showList :: [SubredditWidgets] -> ShowS

Generic SubredditWidgets

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

Defined in Network.Reddit.Types.Widget

Methods

parseJSON :: Value -> Parser SubredditWidgets

parseJSONList :: Value -> Parser [SubredditWidgets]

type Rep SubredditWidgets

Defined in Network.Reddit.Types.Widget

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

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

defaultCalendarConfig :: CalendarConfig

A calendar config with default values

mkCommunityInfo :: SubredditName -> CommunityInfo

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

mkPostFlairWidget :: ShortName -> Seq FlairID -> PostFlairWidget

Make a new PostFlairWidget with default values for most fields

mkTextAreaWidget :: ShortName -> Body -> TextAreaWidget

Create a new TextAreaWidget, with default values for most fields

data WikiPermLevel

Editing permission level configured for a single WikiPage

Constructors

FollowWikiSettings

ApprovedEditorsOnly

ModEditsOnly

Instances

Eq WikiPermLevel

Defined in Network.Reddit.Types.Wiki

Methods

(==) :: WikiPermLevel -> WikiPermLevel -> Bool

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

Ord WikiPermLevel

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

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiPermLevel -> ShowS

show :: WikiPermLevel -> String

showList :: [WikiPermLevel] -> ShowS

Generic WikiPermLevel

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiPermLevel

parseJSONList :: Value -> Parser [WikiPermLevel]

ToHttpApiData WikiPermLevel

Defined in Network.Reddit.Types.Wiki

Methods

toUrlPiece :: WikiPermLevel -> Text

toEncodedUrlPiece :: WikiPermLevel -> Builder

toHeader :: WikiPermLevel -> ByteString

toQueryParam :: WikiPermLevel -> Text

type Rep WikiPermLevel

Defined in Network.Reddit.Types.Wiki

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

The settings that moderators have configured for a single WikiPage

Constructors

WikiPageSettings WikiPermLevel Bool (Seq Username)

Instances

Eq WikiPageSettings

Defined in Network.Reddit.Types.Wiki

Methods

(==) :: WikiPageSettings -> WikiPageSettings -> Bool

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

Show WikiPageSettings

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiPageSettings -> ShowS

show :: WikiPageSettings -> String

showList :: [WikiPageSettings] -> ShowS

Generic WikiPageSettings

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiPageSettings

parseJSONList :: Value -> Parser [WikiPageSettings]

type Rep WikiPageSettings

Defined in Network.Reddit.Types.Wiki

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

Wrapper for listings of WikiPages, which have their own RedditKind

Instances

Show WikiPageListing

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiPageListing -> ShowS

show :: WikiPageListing -> String

showList :: [WikiPageListing] -> ShowS

Generic WikiPageListing

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiPageListing

parseJSONList :: Value -> Parser [WikiPageListing]

type Rep WikiPageListing

Defined in Network.Reddit.Types.Wiki

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

data WikiRevisionID

ID for a wikipage revision

Instances

Eq WikiRevisionID

Defined in Network.Reddit.Types.Wiki

Methods

(==) :: WikiRevisionID -> WikiRevisionID -> Bool

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

Show WikiRevisionID

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiRevisionID -> ShowS

show :: WikiRevisionID -> String

showList :: [WikiRevisionID] -> ShowS

Generic WikiRevisionID

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiRevisionID

parseJSONList :: Value -> Parser [WikiRevisionID]

ToHttpApiData WikiRevisionID

Defined in Network.Reddit.Types.Wiki

Methods

toUrlPiece :: WikiRevisionID -> Text

toEncodedUrlPiece :: WikiRevisionID -> Builder

toHeader :: WikiRevisionID -> ByteString

toQueryParam :: WikiRevisionID -> Text

Thing WikiRevisionID

Defined in Network.Reddit.Types.Wiki

Methods

fullname :: WikiRevisionID -> Text

type Rep WikiRevisionID

Defined in Network.Reddit.Types.Wiki

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

data WikiRevision

Information regarding a single WikiPage revision

Constructors

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

Instances

Eq WikiRevision

Defined in Network.Reddit.Types.Wiki

Methods

(==) :: WikiRevision -> WikiRevision -> Bool

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

Show WikiRevision

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiRevision -> ShowS

show :: WikiRevision -> String

showList :: [WikiRevision] -> ShowS

Generic WikiRevision

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiRevision

parseJSONList :: Value -> Parser [WikiRevision]

Paginable WikiRevision

Defined in Network.Reddit.Types.Wiki

Associated Types

type PaginateOptions WikiRevision

type PaginateThing WikiRevision

Methods

defaultOpts :: PaginateOptions WikiRevision

getFullname :: WikiRevision -> PaginateThing WikiRevision

optsToForm :: PaginateOptions WikiRevision -> Form

type Rep WikiRevision

Defined in Network.Reddit.Types.Wiki

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

Defined in Network.Reddit.Types.Wiki

type PaginateOptions WikiRevision = ()

type PaginateThing WikiRevision

Defined in Network.Reddit.Types.Wiki

type PaginateThing WikiRevision = WikiRevisionID

data WikiPageName

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

Instances

Eq WikiPageName

Defined in Network.Reddit.Types.Wiki

Methods

(==) :: WikiPageName -> WikiPageName -> Bool

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

Show WikiPageName

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiPageName -> ShowS

show :: WikiPageName -> String

showList :: [WikiPageName] -> ShowS

Generic WikiPageName

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiPageName

parseJSONList :: Value -> Parser [WikiPageName]

ToHttpApiData WikiPageName

Defined in Network.Reddit.Types.Wiki

Methods

toUrlPiece :: WikiPageName -> Text

toEncodedUrlPiece :: WikiPageName -> Builder

toHeader :: WikiPageName -> ByteString

toQueryParam :: WikiPageName -> Text

type Rep WikiPageName

Defined in Network.Reddit.Types.Wiki

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

data WikiPage

An individual subreddit wikipage along with its revision information

Constructors

WikiPage Body Body Username UTCTime Bool

Instances

Eq WikiPage

Defined in Network.Reddit.Types.Wiki

Methods

(==) :: WikiPage -> WikiPage -> Bool

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

Show WikiPage

Defined in Network.Reddit.Types.Wiki

Methods

showsPrec :: Int -> WikiPage -> ShowS

show :: WikiPage -> String

showList :: [WikiPage] -> ShowS

Generic WikiPage

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

Defined in Network.Reddit.Types.Wiki

Methods

parseJSON :: Value -> Parser WikiPage

parseJSONList :: Value -> Parser [WikiPage]

type Rep WikiPage

Defined in Network.Reddit.Types.Wiki

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

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