Network.Reddit.Types.Multireddit

Documentation

data Multireddit

An aggregation of individual Subreddits

Constructors

Multireddit

Fields

• name :: MultiName
• displayName :: Text
• subreddits :: Seq SubredditName
• created :: UTCTime
• description :: Body
• descriptionHTML :: Body
• keyColor :: Maybe RGBText
• multipath :: MultiPath
• visibility :: MultiVisibility
• copiedFrom :: Maybe MultiPath

  The path to the original multireddit from which this one was copied, if any, e.g.: /u/USERNAME/m/MULTINAME

• canEdit :: Bool

  Whether the authenticated user can edit this multireddit

• over18 :: Maybe Bool

Instances

Eq Multireddit

Defined in Network.Reddit.Types.Multireddit

Methods

(==) :: Multireddit -> Multireddit -> Bool

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

Show Multireddit

Defined in Network.Reddit.Types.Multireddit

Methods

showsPrec :: Int -> Multireddit -> ShowS

show :: Multireddit -> String

showList :: [Multireddit] -> ShowS

Generic Multireddit

Defined in Network.Reddit.Types.Multireddit

Associated Types

type Rep Multireddit :: Type -> Type

Methods

from :: Multireddit -> Rep Multireddit x

to :: Rep Multireddit x -> Multireddit

FromJSON Multireddit

Defined in Network.Reddit.Types.Multireddit

Methods

parseJSON :: Value -> Parser Multireddit

parseJSONList :: Value -> Parser [Multireddit]

type Rep Multireddit

Defined in Network.Reddit.Types.Multireddit

type Rep Multireddit = D1 ('MetaData "Multireddit" "Network.Reddit.Types.Multireddit" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Multireddit" 'PrefixI 'True) (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MultiName) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subreddits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq SubredditName)))) :*: (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 Body)))) :*: ((S1 ('MetaSel ('Just "keyColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText)) :*: (S1 ('MetaSel ('Just "multipath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MultiPath) :*: S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MultiVisibility))) :*: (S1 ('MetaSel ('Just "copiedFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultiPath)) :*: (S1 ('MetaSel ('Just "canEdit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "over18") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

data MultiName

The name of a Multireddit, which may only contain alphanumeric characters

Instances

Eq MultiName

Defined in Network.Reddit.Types.Multireddit

Methods

(==) :: MultiName -> MultiName -> Bool

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

Show MultiName

Defined in Network.Reddit.Types.Multireddit

Methods

showsPrec :: Int -> MultiName -> ShowS

show :: MultiName -> String

showList :: [MultiName] -> ShowS

Generic MultiName

Defined in Network.Reddit.Types.Multireddit

Associated Types

type Rep MultiName :: Type -> Type

Methods

from :: MultiName -> Rep MultiName x

to :: Rep MultiName x -> MultiName

FromJSON MultiName

Defined in Network.Reddit.Types.Multireddit

Methods

parseJSON :: Value -> Parser MultiName

parseJSONList :: Value -> Parser [MultiName]

ToHttpApiData MultiName

Defined in Network.Reddit.Types.Multireddit

Methods

toUrlPiece :: MultiName -> Text

toEncodedUrlPiece :: MultiName -> Builder

toHeader :: MultiName -> ByteString

toQueryParam :: MultiName -> Text

type Rep MultiName

Defined in Network.Reddit.Types.Multireddit

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

mkMultiName :: MonadThrow m => Text -> m MultiName

Smart constructor for MultiNames, which may only contain alphanumeric characters

data MultiVisibility

The configured visibility level for a Multireddit

Constructors

PrivateMulti

PublicMulti

HiddenMulti

Instances

Eq MultiVisibility

Defined in Network.Reddit.Types.Multireddit

Methods

(==) :: MultiVisibility -> MultiVisibility -> Bool

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

Ord MultiVisibility

Defined in Network.Reddit.Types.Multireddit

Methods

compare :: MultiVisibility -> MultiVisibility -> Ordering

(<) :: MultiVisibility -> MultiVisibility -> Bool

(<=) :: MultiVisibility -> MultiVisibility -> Bool

(>) :: MultiVisibility -> MultiVisibility -> Bool

(>=) :: MultiVisibility -> MultiVisibility -> Bool

max :: MultiVisibility -> MultiVisibility -> MultiVisibility

min :: MultiVisibility -> MultiVisibility -> MultiVisibility

Show MultiVisibility

Defined in Network.Reddit.Types.Multireddit

Methods

showsPrec :: Int -> MultiVisibility -> ShowS

show :: MultiVisibility -> String

showList :: [MultiVisibility] -> ShowS

Generic MultiVisibility

Defined in Network.Reddit.Types.Multireddit

Associated Types

type Rep MultiVisibility :: Type -> Type

Methods

from :: MultiVisibility -> Rep MultiVisibility x

to :: Rep MultiVisibility x -> MultiVisibility

ToJSON MultiVisibility

Defined in Network.Reddit.Types.Multireddit

Methods

toJSON :: MultiVisibility -> Value

toEncoding :: MultiVisibility -> Encoding

toJSONList :: [MultiVisibility] -> Value

toEncodingList :: [MultiVisibility] -> Encoding

FromJSON MultiVisibility

Defined in Network.Reddit.Types.Multireddit

Methods

parseJSON :: Value -> Parser MultiVisibility

parseJSONList :: Value -> Parser [MultiVisibility]

type Rep MultiVisibility

Defined in Network.Reddit.Types.Multireddit

type Rep MultiVisibility = D1 ('MetaData "MultiVisibility" "Network.Reddit.Types.Multireddit" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "PrivateMulti" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PublicMulti" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HiddenMulti" 'PrefixI 'False) (U1 :: Type -> Type)))

data MultiPath

The path to a Multireddit, of the form /user/USERNAME/m/MULTINAME

Constructors

MultiPath

Fields

• username :: Username
• multiname :: MultiName

Instances

Eq MultiPath

Defined in Network.Reddit.Types.Multireddit

Methods

(==) :: MultiPath -> MultiPath -> Bool

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

Show MultiPath

Defined in Network.Reddit.Types.Multireddit

Methods

showsPrec :: Int -> MultiPath -> ShowS

show :: MultiPath -> String

showList :: [MultiPath] -> ShowS

Generic MultiPath

Defined in Network.Reddit.Types.Multireddit

Associated Types

type Rep MultiPath :: Type -> Type

Methods

from :: MultiPath -> Rep MultiPath x

to :: Rep MultiPath x -> MultiPath

FromJSON MultiPath

Defined in Network.Reddit.Types.Multireddit

Methods

parseJSON :: Value -> Parser MultiPath

parseJSONList :: Value -> Parser [MultiPath]

ToHttpApiData MultiPath

Defined in Network.Reddit.Types.Multireddit

Methods

toUrlPiece :: MultiPath -> Text

toEncodedUrlPiece :: MultiPath -> Builder

toHeader :: MultiPath -> ByteString

toQueryParam :: MultiPath -> Text

type Rep MultiPath

Defined in Network.Reddit.Types.Multireddit

type Rep MultiPath = D1 ('MetaData "MultiPath" "Network.Reddit.Types.Multireddit" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "MultiPath" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Username) :*: S1 ('MetaSel ('Just "multiname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MultiName)))

data NewMultiF f

Can represent either a new multireddit when parameterized by Identity, or a multireddit update when parameterized by Maybe. In both cases, keyColor is an optional field

Constructors

NewMultiF

Fields

• description :: HKD f Body
• displayName :: HKD f Text
• subreddits :: HKD f (Seq SubredditName)
• visibility :: HKD f MultiVisibility
• keyColor :: Maybe RGBText

Instances

Show MultiUpdate

Defined in Network.Reddit.Types.Multireddit

Methods

showsPrec :: Int -> MultiUpdate -> ShowS

show :: MultiUpdate -> String

showList :: [MultiUpdate] -> ShowS

Show NewMulti

Defined in Network.Reddit.Types.Multireddit

Methods

showsPrec :: Int -> NewMulti -> ShowS

show :: NewMulti -> String

showList :: [NewMulti] -> ShowS

ToJSON MultiUpdate

Defined in Network.Reddit.Types.Multireddit

Methods

toJSON :: MultiUpdate -> Value

toEncoding :: MultiUpdate -> Encoding

toJSONList :: [MultiUpdate] -> Value

toEncodingList :: [MultiUpdate] -> Encoding

ToJSON NewMulti

Defined in Network.Reddit.Types.Multireddit

Methods

toJSON :: NewMulti -> Value

toEncoding :: NewMulti -> Encoding

toJSONList :: [NewMulti] -> Value

toEncodingList :: [NewMulti] -> Encoding

Generic (NewMultiF f)

Defined in Network.Reddit.Types.Multireddit

Associated Types

type Rep (NewMultiF f) :: Type -> Type

Methods

from :: NewMultiF f -> Rep (NewMultiF f) x

to :: Rep (NewMultiF f) x -> NewMultiF f

type Rep (NewMultiF f)

Defined in Network.Reddit.Types.Multireddit

type Rep (NewMultiF f) = D1 ('MetaData "NewMultiF" "Network.Reddit.Types.Multireddit" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "NewMultiF" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HKD f Body)) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HKD f Text))) :*: (S1 ('MetaSel ('Just "subreddits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HKD f (Seq SubredditName))) :*: (S1 ('MetaSel ('Just "visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HKD f MultiVisibility)) :*: S1 ('MetaSel ('Just "keyColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RGBText))))))

type NewMulti = NewMultiF Identity

An new multireddit, where all fields are required

type MultiUpdate = NewMultiF Maybe

An update to a multireddit, where all fields are optional. If a field is not provided, it is omitted during JSON encoding

multiUpdate :: Multireddit -> MultiUpdate

Convert a Multireddit to a MultiUpdate

defaultMultiUpdate :: MultiUpdate

A MultiUpdate with all Nothing fields, for convenience