Copyright	(c) 2021 Rory Tyler Hayford
License	BSD-3-Clause
Maintainer	rory.hayford@protonmail.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Network.Reddit.Types.Widget

Contents

Individual widget types

Description

Synopsis

data SubredditWidgets = SubredditWidgets {
- idCard :: IDCardWidget
- moderators :: ModeratorsWidget
- topbar :: Seq Widget
- sidebar :: Seq Widget
- topbarOrder :: Seq WidgetID
- sidebarOrder :: Seq WidgetID
}
data Widget
- = Buttons ButtonWidget
- | Calendar CalendarWidget
- | CommunityList CommunityListWidget
- | Custom CustomWidget
- | IDCard IDCardWidget
- | Images ImageWidget
- | Moderators ModeratorsWidget
- | Menu MenuWidget
- | PostFlair PostFlairWidget
- | Rules RulesWidget
- | TextArea TextAreaWidget
newtype WidgetID = WidgetID Text
data WidgetSection
- = Topbar
- | Sidebar
data ShortName
mkShortName :: MonadThrow m => Text -> m ShortName
data WidgetList
data WidgetStyles = WidgetStyles {
- backgroundColor :: Maybe RGBText
- headerColor :: Maybe RGBText
}
data ButtonWidget = ButtonWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- buttons :: Seq Button
- description :: Body
- descriptionHTML :: Maybe Body
- styles :: Maybe WidgetStyles
}
data Button
- = ImageButton ButtonImage
- | TextButton ButtonText
data ButtonImage = ButtonImage {
- text :: ShortName
- url :: UploadURL
- linkURL :: URL
- height :: Int
- width :: Int
- hoverState :: Maybe ButtonHover
}
data ButtonText = ButtonText {
- text :: ShortName
- url :: URL
- color :: RGBText
- fillColor :: Maybe RGBText
- textColor :: Maybe RGBText
- hoverState :: Maybe ButtonHover
}
data ButtonHover
- = ImageButtonHover ImageHover
- | TextButtonHover TextHover
data ImageHover = ImageHover {
- url :: UploadURL
- height :: Maybe Integer
- width :: Maybe Integer
}
data TextHover = TextHover {
- text :: ShortName
- color :: Maybe RGBText
- fillColor :: Maybe RGBText
- textColor :: Maybe RGBText
}
data CalendarWidget = CalendarWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- googleCalendarID :: Text
- configuration :: CalendarConfig
- requiresSync :: Bool
- styles :: Maybe WidgetStyles
}
data CalendarConfig = CalendarConfig {
- numEvents :: Word
- showDate :: Bool
- showDescription :: Bool
- showLocation :: Bool
- showTime :: Bool
- showTitle :: Bool
}
defaultCalendarConfig :: CalendarConfig
data CommunityListWidget = CommunityListWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- communities :: Seq CommunityInfo
- styles :: Maybe WidgetStyles
}
data CommunityInfo = CommunityInfo {
- name :: SubredditName
- subscribers :: Maybe Integer
- primaryColor :: Maybe RGBText
- iconURL :: Maybe URL
- communityIcon :: Maybe URL
- isSubscribed :: Maybe Bool
- isNSFW :: Maybe Bool
}
mkCommunityInfo :: SubredditName -> CommunityInfo
data CustomWidget = CustomWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- text :: Body
- imageData :: Seq ImageData
- height :: Int
- textHTML :: Maybe Body
- css :: Maybe Text
- stylesheetURL :: Maybe URL
- styles :: Maybe WidgetStyles
}
data ImageData = ImageData {
- name :: Name
- height :: Int
- width :: Int
- url :: UploadURL
}
data IDCardWidget = IDCardWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- description :: Body
- subscribersText :: Text
- currentlyViewingText :: Text
- subscribersCount :: Maybe Integer
- currentlyViewingCount :: Maybe Integer
- styles :: Maybe WidgetStyles
}
data ImageWidget = ImageWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- images :: Seq Image
- styles :: Maybe WidgetStyles
}
data Image = Image {
- width :: Integer
- height :: Integer
- url :: UploadURL
- linkURL :: Maybe URL
}
data MenuWidget = MenuWidget {
- widgetID :: Maybe WidgetID
- children :: Seq MenuChild
}
data MenuChild
- = SubmenuChild Submenu
- | MenuLinkChild MenuLink
data MenuLink = MenuLink {
- text :: Text
- url :: URL
}
data Submenu = Submenu {
- children :: Seq MenuLink
- text :: Text
}
data ModeratorsWidget = ModeratorsWidget {
- widgetID :: Maybe WidgetID
- mods :: Seq ModInfo
- totalMods :: Maybe Int
- styles :: Maybe WidgetStyles
}
data ModInfo = ModInfo {
- name :: Username
- flairText :: Maybe FlairText
- flairTextColor :: Maybe ForegroundColor
- flairBackgroundColor :: Maybe RGBText
}
data PostFlairWidget = PostFlairWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- order :: Seq FlairID
- templates :: HashMap FlairID PostFlairInfo
- display :: PostFlairWidgetDisplay
- styles :: Maybe WidgetStyles
}
mkPostFlairWidget :: ShortName -> Seq FlairID -> PostFlairWidget
data PostFlairInfo = PostFlairInfo {
- templateID :: FlairID
- text :: Text
- textColor :: ForegroundColor
- backgroundColor :: RGBText
}
data PostFlairWidgetDisplay
- = CloudDisplay
- | ListDisplay
data RulesWidget = RulesWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- rules :: Seq SubredditRule
- display :: RulesDisplay
- styles :: Maybe WidgetStyles
}
data RulesDisplay
- = FullDisplay
- | CompactDisplay
data TextAreaWidget = TextAreaWidget {
- widgetID :: Maybe WidgetID
- shortName :: ShortName
- text :: Body
- textHTML :: Maybe Body
- styles :: Maybe WidgetStyles
}
mkTextAreaWidget :: ShortName -> Body -> TextAreaWidget

Documentation

data SubredditWidgets Source #

An organized collection of a subreddit's widgets

Constructors

SubredditWidgets
Fields idCard :: IDCardWidget moderators :: ModeratorsWidget topbar :: Seq Widget sidebar :: Seq Widget topbarOrder :: Seq WidgetID sidebarOrder :: Seq WidgetID

Instances

Instances details

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

data Widget Source #

Represents one of various kinds of widgets

Instances

newtype WidgetID Source #

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

Constructors

WidgetID Text

Instances

Instances details

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

data WidgetSection Source #

The section in which certain Widgets appear

Constructors

Topbar
Sidebar

Instances

Instances details

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

data ShortName Source #

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

Instances

Instances details

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

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

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

data WidgetList Source #

Wrapper to parse a HashMap WidgetID Widget, discarding the ID keys

Instances

Instances details

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

data WidgetStyles Source #

Style options for an individual widget

Constructors

WidgetStyles
Fields backgroundColor :: Maybe RGBText headerColor :: Maybe RGBText

Instances

Instances details

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

Individual widget types

All of the widget types in this module have a widgetID field with the type Maybe WidgetID. This field should be present when fetching existing widgets, but should be left as Nothing if creating a new widget

data ButtonWidget Source #

A widget containing buttons

Constructors

ButtonWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName buttons :: Seq Button description :: Body descriptionHTML :: Maybe Body styles :: Maybe WidgetStyles

Instances

Instances details

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

data Button Source #

An individual button in a ButtonWidget

Constructors

ImageButton ButtonImage
TextButton ButtonText

Instances

Instances details

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

data ButtonImage Source #

Data for an ImageButton

Constructors

ButtonImage
Fields text :: ShortName url :: UploadURL linkURL :: URL height :: Int width :: Int hoverState :: Maybe ButtonHover

Instances

Instances details

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

data ButtonText Source #

Data for a TextButton

Constructors

ButtonText
Fields text :: ShortName url :: URL color :: RGBText fillColor :: Maybe RGBText textColor :: Maybe RGBText hoverState :: Maybe ButtonHover

Instances

Instances details

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

data ButtonHover Source #

The state of the Button when hovering over it

Constructors

ImageButtonHover ImageHover
TextButtonHover TextHover

Instances

Instances details

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

data ImageHover Source #

The state of an ImageButton when hovering over it

Constructors

ImageHover
Fields url :: UploadURL height :: Maybe Integer width :: Maybe Integer

Instances

Instances details

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

data TextHover Source #

The state of a TextButton when hovering over it

Constructors

TextHover
Fields text :: ShortName color :: Maybe RGBText fillColor :: Maybe RGBText textColor :: Maybe RGBText

Instances

Instances details

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

data CalendarWidget Source #

A widget representing a calendar

Constructors

CalendarWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName googleCalendarID :: Text configuration :: CalendarConfig requiresSync :: Bool styles :: Maybe WidgetStyles

Instances

Instances details

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

data CalendarConfig Source #

Configuration options for a CalendarWidget

Constructors

CalendarConfig
Fields numEvents :: Word Between 1 and 50, defaulting to 10 showDate :: Bool showDescription :: Bool showLocation :: Bool showTime :: Bool showTitle :: Bool

Instances

Instances details

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

defaultCalendarConfig :: CalendarConfig Source #

A calendar config with default values

data CommunityListWidget Source #

A widget listing related subreddits

Constructors

CommunityListWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName communities :: Seq CommunityInfo styles :: Maybe WidgetStyles

Instances

Instances details

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

data CommunityInfo Source #

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

Constructors

CommunityInfo
Fields name :: SubredditName subscribers :: Maybe Integer primaryColor :: Maybe RGBText iconURL :: Maybe URL communityIcon :: Maybe URL isSubscribed :: Maybe Bool If the authenticated user is subscribed to the subreddit isNSFW :: Maybe Bool

Instances

Instances details

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

mkCommunityInfo :: SubredditName -> CommunityInfo Source #

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

data CustomWidget Source #

A custom widget

Constructors

CustomWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName text :: Body imageData :: Seq ImageData height :: Int Should be between 50 and 500 textHTML :: Maybe Body Should be `Nothing` when creating a new widget css :: Maybe Text stylesheetURL :: Maybe URL styles :: Maybe WidgetStyles

Instances

Instances details

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

data ImageData Source #

Image data that belongs to a CustomWidget

Constructors

ImageData
Fields name :: Name height :: Int width :: Int url :: UploadURL This url must point to an image hosted by Reddit

Instances

Instances details

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

data IDCardWidget Source #

An ID card displaying information about the subreddit

Constructors

IDCardWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName description :: Body subscribersText :: Text currentlyViewingText :: Text subscribersCount :: Maybe Integer currentlyViewingCount :: Maybe Integer styles :: Maybe WidgetStyles

Instances

Instances details

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

data ImageWidget Source #

A widget composed of various Images

Constructors

ImageWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName images :: Seq Image styles :: Maybe WidgetStyles

Instances

Instances details

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

data Image Source #

An individual image in an ImageWidget

Constructors

Image
Fields width :: Integer height :: Integer url :: UploadURL The reddit-hosted image URL linkURL :: Maybe URL The link that is followed when clicking on the image

Instances

Instances details

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

data MenuWidget Source #

A widget representing a menu

Constructors

MenuWidget
Fields widgetID :: Maybe WidgetID children :: Seq MenuChild

Instances

Instances details

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

data MenuChild Source #

A child widget in a MenuWidget

Constructors

SubmenuChild Submenu
MenuLinkChild MenuLink

Instances

Instances details

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

data MenuLink Source #

A link in a MenuWidget or Submenu

Constructors

MenuLink
Fields text :: Text url :: URL

Instances

Instances details

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

data Submenu Source #

A submenu child in a MenuWidget which contains MenuLinks

Constructors

Submenu
Fields children :: Seq MenuLink text :: Text

Instances

Instances details

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

data ModeratorsWidget Source #

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

Constructors

ModeratorsWidget
Fields widgetID :: Maybe WidgetID mods :: Seq ModInfo totalMods :: Maybe Int styles :: Maybe WidgetStyles

Instances

Instances details

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

data ModInfo Source #

Information about a moderator as displayed in a ModeratorsWidget

Constructors

ModInfo
Fields name :: Username flairText :: Maybe FlairText flairTextColor :: Maybe ForegroundColor flairBackgroundColor :: Maybe RGBText

Instances

Instances details

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

data PostFlairWidget Source #

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

Constructors

PostFlairWidget

Fields

widgetID :: Maybe WidgetID
shortName :: ShortName
order :: Seq FlairID
A container of FlairIDs corresponding to the flair templates listed in the widget. Use this field when updating or creating PostFlairWidgets
templates :: HashMap FlairID PostFlairInfo
A mapping of submission flair template IDs to brief information on each one. This field is not serialized when creating a new PostFlairWidget or when updating an existing one, and can be left empty in those cases
display :: PostFlairWidgetDisplay
styles :: Maybe WidgetStyles

Instances

Instances details

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

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

Make a new PostFlairWidget with default values for most fields

data PostFlairInfo Source #

Information about submission flair templates in a PostFlairWidget

Constructors

PostFlairInfo
Fields templateID :: FlairID text :: Text textColor :: ForegroundColor backgroundColor :: RGBText

Instances

Instances details

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

data PostFlairWidgetDisplay Source #

The display orientation for PostFlairWidgets

Constructors

CloudDisplay
ListDisplay

Instances

Instances details

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

data RulesWidget Source #

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

Constructors

RulesWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName rules :: Seq SubredditRule display :: RulesDisplay styles :: Maybe WidgetStyles

Instances

Instances details

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

data RulesDisplay Source #

Display style for a RulesWidget

Constructors

FullDisplay
CompactDisplay

Instances

Instances details

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

data TextAreaWidget Source #

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

Constructors

TextAreaWidget
Fields widgetID :: Maybe WidgetID shortName :: ShortName text :: Body Markdown-formatted textHTML :: Maybe Body This is present in existing widgets, but should be left blank when creating a new one styles :: Maybe WidgetStyles

Instances

Instances details

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

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

Create a new TextAreaWidget, with default values for most fields

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

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