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

Contents

Actions
- Filters
Types

Description

Actions for Multireddits composed of several Subreddits

Synopsis

getMultireddit :: MonadReddit m => MultiPath -> m Multireddit
addToMultireddit :: MonadReddit m => MultiPath -> SubredditName -> m ()
removeFromMultireddit :: MonadReddit m => MultiPath -> SubredditName -> m ()
deleteMultireddit :: MonadReddit m => MultiPath -> m ()
copyMultireddit :: MonadReddit m => MultiPath -> MultiName -> m Multireddit
createMultireddit :: MonadReddit m => NewMulti -> MultiPath -> m Multireddit
updateMultireddit :: MonadReddit m => MultiUpdate -> MultiPath -> m Multireddit
listFilters :: MonadReddit m => SubredditName -> m Multireddit
addFilter :: MonadReddit m => SubredditName -> SubredditName -> m ()
removeFilter :: MonadReddit m => SubredditName -> SubredditName -> m ()
clearFilters :: MonadReddit m => SubredditName -> m ()
type MultiUpdate = NewMultiF Maybe
type NewMulti = NewMultiF Identity
data NewMultiF f = NewMultiF (HKD f Body) (HKD f Text) (HKD f (Seq SubredditName)) (HKD f MultiVisibility) (Maybe RGBText)
data MultiVisibility
- = PrivateMulti
- | PublicMulti
- | HiddenMulti
data MultiPath = MultiPath Username MultiName
data MultiName
data Multireddit = Multireddit MultiName Text (Seq SubredditName) UTCTime Body Body (Maybe RGBText) MultiPath MultiVisibility (Maybe MultiPath) Bool (Maybe Bool)
mkMultiName :: MonadThrow m => Text -> m MultiName
multiUpdate :: Multireddit -> MultiUpdate
defaultMultiUpdate :: MultiUpdate

Actions

getMultireddit :: MonadReddit m => MultiPath -> m Multireddit Source #

Get a Multireddit by its path

addToMultireddit :: MonadReddit m => MultiPath -> SubredditName -> m () Source #

Add the given subreddit to the existing multireddit

removeFromMultireddit :: MonadReddit m => MultiPath -> SubredditName -> m () Source #

Remove a single subreddit from the existing multireddit

deleteMultireddit :: MonadReddit m => MultiPath -> m () Source #

Delete an existing multireddit

copyMultireddit :: MonadReddit m => MultiPath -> MultiName -> m Multireddit Source #

Copy an existing Multireddit, returning the new one

createMultireddit :: MonadReddit m => NewMulti -> MultiPath -> m Multireddit Source #

Create a new Multireddit. Will throw a 409 ErrorWithStatus if the proposed multireddit already exists. The new multireddit will be created at the provided MultiPath parameter

updateMultireddit :: MonadReddit m => MultiUpdate -> MultiPath -> m Multireddit Source #

Update an existings multireddit, returning the same Multireddit with the updates applied

Filters

These filters only work on the special subreddits "all" and "mod". When a filter subreddit is added, it will no longer appear in Listings for the special subreddit. All of the actions will throw ErrorWithStatus exceptions if a non-special subreddit is provided as the first argument. Filters are provided as types of Multireddits

listFilters :: MonadReddit m => SubredditName -> m Multireddit Source #

List all of the filters configured for the special subreddit. If no filters have been applied, this will throw an ErrorWithStatus exception

addFilter Source #

Arguments

:: MonadReddit m
=> SubredditName	The special sub
-> SubredditName	The sub to filter
-> m ()

Add a subreddit to filter from the special subreddit

removeFilter Source #

Arguments

:: MonadReddit m
=> SubredditName	The special sub
-> SubredditName	The sub to remove from the filter
-> m ()

Remove a filtered subreddit from the special subreddit. This action will succeed even if the filtered subreddit is not in the special subreddit filter

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

Remove all of the filters for the special subreddit

Types

type MultiUpdate = NewMultiF Maybe Source #

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

type NewMulti = NewMultiF Identity Source #

An new multireddit, where all fields are required

data NewMultiF f Source #

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 (HKD f Body) (HKD f Text) (HKD f (Seq SubredditName)) (HKD f MultiVisibility) (Maybe RGBText)

Instances

Instances details

Show MultiUpdate Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods showsPrec :: Int -> MultiUpdate -> ShowS # show :: MultiUpdate -> String # showList :: [MultiUpdate] -> ShowS #
Show NewMulti Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods showsPrec :: Int -> NewMulti -> ShowS # show :: NewMulti -> String # showList :: [NewMulti] -> ShowS #
ToJSON MultiUpdate Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods toJSON :: MultiUpdate -> Value # toEncoding :: MultiUpdate -> Encoding # toJSONList :: [MultiUpdate] -> Value # toEncodingList :: [MultiUpdate] -> Encoding #
ToJSON NewMulti Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods toJSON :: NewMulti -> Value # toEncoding :: NewMulti -> Encoding # toJSONList :: [NewMulti] -> Value # toEncodingList :: [NewMulti] -> Encoding #
Generic (NewMultiF f) Source #
Instance details 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) Source #
Instance details Defined in Network.Reddit.Types.Multireddit type Rep (NewMultiF f) = D1 ('MetaData "NewMultiF" "Network.Reddit.Types.Multireddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" '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))))))

data MultiVisibility Source #

The configured visibility level for a Multireddit

Constructors

PrivateMulti
PublicMulti
HiddenMulti

Instances

Instances details

Eq MultiVisibility Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods (==) :: MultiVisibility -> MultiVisibility -> Bool # (/=) :: MultiVisibility -> MultiVisibility -> Bool #
Ord MultiVisibility Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods showsPrec :: Int -> MultiVisibility -> ShowS # show :: MultiVisibility -> String # showList :: [MultiVisibility] -> ShowS #
Generic MultiVisibility Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods toJSON :: MultiVisibility -> Value # toEncoding :: MultiVisibility -> Encoding # toJSONList :: [MultiVisibility] -> Value # toEncodingList :: [MultiVisibility] -> Encoding #
FromJSON MultiVisibility Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods parseJSON :: Value -> Parser MultiVisibility # parseJSONList :: Value -> Parser [MultiVisibility] #
type Rep MultiVisibility Source #
Instance details Defined in Network.Reddit.Types.Multireddit type Rep MultiVisibility = D1 ('MetaData "MultiVisibility" "Network.Reddit.Types.Multireddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" '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 Source #

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

Constructors

MultiPath Username MultiName

Instances

Instances details

Eq MultiPath Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods (==) :: MultiPath -> MultiPath -> Bool # (/=) :: MultiPath -> MultiPath -> Bool #
Show MultiPath Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods showsPrec :: Int -> MultiPath -> ShowS # show :: MultiPath -> String # showList :: [MultiPath] -> ShowS #
Generic MultiPath Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods parseJSON :: Value -> Parser MultiPath # parseJSONList :: Value -> Parser [MultiPath] #
ToHttpApiData MultiPath Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods toUrlPiece :: MultiPath -> Text # toEncodedUrlPiece :: MultiPath -> Builder # toHeader :: MultiPath -> ByteString # toQueryParam :: MultiPath -> Text #
type Rep MultiPath Source #
Instance details Defined in Network.Reddit.Types.Multireddit type Rep MultiPath = D1 ('MetaData "MultiPath" "Network.Reddit.Types.Multireddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" '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 MultiName Source #

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

Instances

Instances details

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

data Multireddit Source #

An aggregation of individual Subreddits

Constructors

Multireddit MultiName Text (Seq SubredditName) UTCTime Body Body (Maybe RGBText) MultiPath MultiVisibility (Maybe MultiPath) Bool (Maybe Bool)

Instances

Instances details

Eq Multireddit Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods (==) :: Multireddit -> Multireddit -> Bool # (/=) :: Multireddit -> Multireddit -> Bool #
Show Multireddit Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods showsPrec :: Int -> Multireddit -> ShowS # show :: Multireddit -> String # showList :: [Multireddit] -> ShowS #
Generic Multireddit Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types.Multireddit Methods parseJSON :: Value -> Parser Multireddit # parseJSONList :: Value -> Parser [Multireddit] #
type Rep Multireddit Source #
Instance details Defined in Network.Reddit.Types.Multireddit type Rep Multireddit = D1 ('MetaData "Multireddit" "Network.Reddit.Types.Multireddit" "heddit-0.2-6CPbqZeiNUj1PM6nX368ZU" '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)))))))

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

Smart constructor for MultiNames, which may only contain alphanumeric characters

multiUpdate :: Multireddit -> MultiUpdate Source #

Convert a Multireddit to a MultiUpdate

defaultMultiUpdate :: MultiUpdate Source #

A MultiUpdate with all Nothing fields, for convenience