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

Description

Synopsis

data WikiPage = WikiPage {
- content :: Body
- contentHTML :: Body
- revisionBy :: Username
- revisionDate :: UTCTime
- mayRevise :: Bool
}
newtype WikiRevisionID = WikiRevisionID Text
data WikiPageName
mkWikiPageName :: Text -> WikiPageName
data WikiPageListing
data WikiRevision = WikiRevision {
- revisionID :: WikiRevisionID
- page :: WikiPageName
- timestamp :: UTCTime
- author :: Username
- reason :: Maybe Text
- hidden :: Maybe Bool
}
data WikiPageSettings = WikiPageSettings {
- permlevel :: WikiPermLevel
- listed :: Bool
- allowedEditors :: Seq Username
}
data WikiPermLevel

Documentation

data WikiPage Source #

An individual subreddit wikipage along with its revision information

Constructors

WikiPage
Fields content :: Body The page content, as markdown contentHTML :: Body revisionBy :: Username revisionDate :: UTCTime mayRevise :: Bool Indicates whether the authenticated user can revise this particular wikipage

Instances

Instances details

Eq WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods (==) :: WikiPage -> WikiPage -> Bool # (/=) :: WikiPage -> WikiPage -> Bool #
Show WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods showsPrec :: Int -> WikiPage -> ShowS # show :: WikiPage -> String # showList :: [WikiPage] -> ShowS #
Generic WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type Rep WikiPage :: Type -> Type # Methods from :: WikiPage -> Rep WikiPage x # to :: Rep WikiPage x -> WikiPage #
FromJSON WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods parseJSON :: Value -> Parser WikiPage # parseJSONList :: Value -> Parser [WikiPage] #
type Rep WikiPage Source #
Instance details Defined in Network.Reddit.Types.Wiki type Rep WikiPage = D1 ('MetaData "WikiPage" "Network.Reddit.Types.Wiki" "heddit-0.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)))))

newtype WikiRevisionID Source #

ID for a wikipage revision

Constructors

WikiRevisionID Text

Instances

Instances details

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

data WikiPageName Source #

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

Instances

Instances details

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

mkWikiPageName :: Text -> WikiPageName Source #

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

data WikiPageListing Source #

Wrapper for listings of WikiPages, which have their own RedditKind

Instances

Instances details

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

data WikiRevision Source #

Information regarding a single WikiPage revision

Constructors

WikiRevision
Fields revisionID :: WikiRevisionID page :: WikiPageName timestamp :: UTCTime author :: Username reason :: Maybe Text The reason for editing the page, if any hidden :: Maybe Bool If the revision has been hidden

Instances

Instances details

Eq WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods (==) :: WikiRevision -> WikiRevision -> Bool # (/=) :: WikiRevision -> WikiRevision -> Bool #
Show WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods showsPrec :: Int -> WikiRevision -> ShowS # show :: WikiRevision -> String # showList :: [WikiRevision] -> ShowS #
Generic WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type Rep WikiRevision :: Type -> Type # Methods from :: WikiRevision -> Rep WikiRevision x # to :: Rep WikiRevision x -> WikiRevision #
FromJSON WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods parseJSON :: Value -> Parser WikiRevision # parseJSONList :: Value -> Parser [WikiRevision] #
Paginable WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type PaginateOptions WikiRevision Source # type PaginateThing WikiRevision Source # Methods defaultOpts :: PaginateOptions WikiRevision Source # getFullname :: WikiRevision -> PaginateThing WikiRevision Source # optsToForm :: PaginateOptions WikiRevision -> Form Source #
type Rep WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki type Rep WikiRevision = D1 ('MetaData "WikiRevision" "Network.Reddit.Types.Wiki" "heddit-0.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 Source #
Instance details Defined in Network.Reddit.Types.Wiki type PaginateOptions WikiRevision = ()
type PaginateThing WikiRevision Source #
Instance details Defined in Network.Reddit.Types.Wiki type PaginateThing WikiRevision = WikiRevisionID

data WikiPageSettings Source #

The settings that moderators have configured for a single WikiPage

Constructors

WikiPageSettings
Fields permlevel :: WikiPermLevel listed :: Bool allowedEditors :: Seq Username

Instances

Instances details

Eq WikiPageSettings Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods (==) :: WikiPageSettings -> WikiPageSettings -> Bool # (/=) :: WikiPageSettings -> WikiPageSettings -> Bool #
Show WikiPageSettings Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods showsPrec :: Int -> WikiPageSettings -> ShowS # show :: WikiPageSettings -> String # showList :: [WikiPageSettings] -> ShowS #
Generic WikiPageSettings Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type Rep WikiPageSettings :: Type -> Type # Methods from :: WikiPageSettings -> Rep WikiPageSettings x # to :: Rep WikiPageSettings x -> WikiPageSettings #
FromJSON WikiPageSettings Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods parseJSON :: Value -> Parser WikiPageSettings # parseJSONList :: Value -> Parser [WikiPageSettings] #
type Rep WikiPageSettings Source #
Instance details Defined in Network.Reddit.Types.Wiki type Rep WikiPageSettings = D1 ('MetaData "WikiPageSettings" "Network.Reddit.Types.Wiki" "heddit-0.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 WikiPermLevel Source #

Editing permission level configured for a single WikiPage

Constructors

FollowWikiSettings
ApprovedEditorsOnly
ModEditsOnly

Instances

Instances details

Eq WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods (==) :: WikiPermLevel -> WikiPermLevel -> Bool # (/=) :: WikiPermLevel -> WikiPermLevel -> Bool #
Ord WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods compare :: WikiPermLevel -> WikiPermLevel -> Ordering # (<) :: WikiPermLevel -> WikiPermLevel -> Bool # (<=) :: WikiPermLevel -> WikiPermLevel -> Bool # (>) :: WikiPermLevel -> WikiPermLevel -> Bool # (>=) :: WikiPermLevel -> WikiPermLevel -> Bool # max :: WikiPermLevel -> WikiPermLevel -> WikiPermLevel # min :: WikiPermLevel -> WikiPermLevel -> WikiPermLevel #
Show WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods showsPrec :: Int -> WikiPermLevel -> ShowS # show :: WikiPermLevel -> String # showList :: [WikiPermLevel] -> ShowS #
Generic WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki Associated Types type Rep WikiPermLevel :: Type -> Type # Methods from :: WikiPermLevel -> Rep WikiPermLevel x # to :: Rep WikiPermLevel x -> WikiPermLevel #
FromJSON WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods parseJSON :: Value -> Parser WikiPermLevel # parseJSONList :: Value -> Parser [WikiPermLevel] #
ToHttpApiData WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki Methods toUrlPiece :: WikiPermLevel -> Text # toEncodedUrlPiece :: WikiPermLevel -> Builder # toHeader :: WikiPermLevel -> ByteString # toQueryParam :: WikiPermLevel -> Text #
type Rep WikiPermLevel Source #
Instance details Defined in Network.Reddit.Types.Wiki type Rep WikiPermLevel = D1 ('MetaData "WikiPermLevel" "Network.Reddit.Types.Wiki" "heddit-0.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)))