Network.Reddit

Documentation

newClient :: (MonadUnliftIO m, MonadThrow m) => AuthConfig -> m Client

Create a new Client for API access, given an AuthConfig. This client is required to run all actions in this library.

See loadClient if you have a ScriptApp or ApplicationOnly app and would like to load your auth details from an ini file

newClientWithManager :: (MonadUnliftIO m, MonadCatch m) => TokenManager -> AuthConfig -> m Client

Create a new client with an existing refresh token, for WebApps and InstalledApps. The initial refresh token is provided with a TokenManager that will also handle saving and loading refresh tokens over the life of the new Client

loadClient :: (MonadUnliftIO m, MonadThrow m) => Maybe ClientSite -> m Client

Load a client from saved credentials, which are stored in an ini file. Files should conform to the following formats:

For ScriptApps:

[NAME]
id = <clientID>
secret = <clientSecret>
username = <username>
password = <password>
agent = <platform>,<appID>,<version>,<author>

For ApplicationOnly apps without a user context:

[NAME]
id = <clientID>
secret = <clientSecret>
agent = <platform>,<appID>,<version>,<author>

Where NAME corresponds to a ClientSite that you pass to this function. You can have various different distinct sites in a single ini file. When invoking this function, if the provided client site is Nothing, a section labeled [DEFAULT] will be used. If none is provided, an exception will be thrown. Note that all section labels are case-insensitive.

The following locations are searched for an ini file, in order:

• $PWD/auth.ini
• $XDG_CONFIG_HOME/heddit/auth.ini

Note: Only ScriptApps and ApplicationOnly are supported via this method

getAuthURL

Arguments

:: Foldable t

=> URL

A redirect URI, which must exactly match the one registered with Reddit when creating your application

-> TokenDuration

-> t Scope

The OAuth scopes to request authorization for

-> ClientID

-> Text

Text that is embedded in the callback URI when the client completes the request. It must be composed of printable ASCII characters and should be unique for the client

-> URL

Get the URL required to authorize your application, for WebApps and InstalledApps

runReddit :: (MonadCatch m, MonadIO m) => Client -> RedditT m a -> m a

Run an action with your Reddit Client. This will catch any exceptions related to POST rate-limiting for you. After sleeping for the indicated duration, it will attempt to re-run the action that triggered the exception. If you do not wish to catch these exceptions, or would like to handle them in a different way, use runRedditT, which simply runs the provided action

Note: Confusingly, Reddit uses two different rate-limiting mechanisms. This action only catches rate limiting applied to POST requests. Another form of rate limiting is applied to API requests in general. This library does not automatically deal with this second type. If you wish to deal with this yourself, see the action withRateLimitDelay, which automatically applies a delay based on the most recent rate limit headers returned from Reddit

runRedditT :: Client -> RedditT m a -> m a

Run a RedditT action

tryReddit :: forall e a m. (Exception e, MonadCatch m, MonadIO m) => Client -> RedditT m a -> m (Either e a)

Run an action with your Reddit Client, catching the exception specified and returning an Either in case of failure. It may be best to use TypeApplications to specify the exception type.

For example, to try to see the user FlairTemplates for a subreddit which may or may not allow user flair:

>>> tryReddit @APIException c $ getUserFlairTemplates =<< mkSubredditName "haskell"
Left (ErrorWithStatus (StatusMessage {statusCode = 403, message = "Forbidden"}))

getRateLimits :: MonadReddit m => m (Maybe RateLimits)

Get current information on rate limiting, if any

withRateLimitDelay :: MonadReddit m => m a -> m a

Run the provided MonadReddit action with a delay, if rate-limiting information is currently available

fileTokenManager

Arguments

:: Exception e

=> e

An exception that will be thrown when Reddit doesn't return a new refresh token

-> FilePath

The location of the stored tokens

-> TokenManager

This is an example TokenManager that can be used to store and retrieve OAUth refresh tokens, which could be used with newClientWithManager. For a real application, you would probably want to use a more sophisticated manager

Actions

firstPage :: (MonadReddit m, Paginable a) => (Paginator t a -> m (Listing t a)) -> m (Seq a)

Convenience wrapper for actions taking a Paginator and which return a Listing. This runs the action with a default initial paginator, and extracts the children from the returned Listing. This discards all of the pagination controls that are returned in the Listing. This is useful if you only care about the child contents of the first "page" of results

For example, to get only the first page of results for a user's comments, you could use the following:

runReddit yourClient . firstPage $ getUserComments someUsername

nextPage :: forall t a. Paginable a => Maybe (Paginator t a) -> Listing t a -> Paginator t a

Update a Paginator with a Listing to make a query for the next "page" of content. If the first argument is Nothing, defaults will be used for the options, partially depending on the type of paginator

Note: You cannot supply both the before and after fields when making requests to API endpoints. If both fields are Just in the Paginator you get back from this function, the after field will take precedence. If you want to use before in such a scenario, make sure to set it to Nothing before using the paginator in an action

Example:

>>> best1 <- runReddit yourClient $ getBest emptyPaginator
>>> best2 <- runReddit yourClient . getBest $ nextPage Nothing best1

emptyPaginator :: forall t a. Paginable a => Paginator t a

An empty, default Paginator. Includes the default PaginateOptions for the type a

stream

Arguments

:: forall m t a. (MonadReddit m, Paginable a, t ~ PaginateThing a)

=> Maybe Bool

When True, will only yield items that have newly arrived, thus skipping items from the first request that already existed

-> (Paginator t a -> m (Listing t a))

-> ConduitT () a m ()

Transform an action producing a Listing of items into an infinite stream. Items are pushed to the stream as they are fetched, with oldest items yielded first. New items are fetched in 100-item batches. If nothing new arrives in the stream, a jittered exponential backoff is applied, up to a cap of ~16s, resetting once new items arrive again.

For example, to fetch new submissions published to "r/haskell", as they are created, and print their IDs to the console:

>>> import Conduit
>>> subName <- mkSubredditName "haskell"
>>> action = getNewSubmissions subName
>>> printTitle = liftIO . print . (^. #title)
>>> runReddit c . runConduit $ stream Nothing action  .| mapM_C printTitle
SubmissionID "o6948i"
SubmissionID "o6b0w0"
SubmissionID "o6cqof"
SubmissionID "o6ddl9"
SubmissionID "o6dlas"
...

Basic types

type MonadReddit m = (MonadUnliftIO m, MonadThrow m, MonadCatch m, MonadReader Client m)

Synonym for constraints that RedditT actions must satisfy

data RedditT m a

The monad tranformer in which Reddit API transactions can be executed

Instances

Monad m => MonadReader Client (RedditT m)

Defined in Network.Reddit.Types

Methods

ask :: RedditT m Client

local :: (Client -> Client) -> RedditT m a -> RedditT m a

reader :: (Client -> a) -> RedditT m a

Monad m => Monad (RedditT m)

Defined in Network.Reddit.Types

Methods

(>>=) :: RedditT m a -> (a -> RedditT m b) -> RedditT m b

(>>) :: RedditT m a -> RedditT m b -> RedditT m b

return :: a -> RedditT m a

Functor m => Functor (RedditT m)

Defined in Network.Reddit.Types

Methods

fmap :: (a -> b) -> RedditT m a -> RedditT m b

(<$) :: a -> RedditT m b -> RedditT m a

Applicative m => Applicative (RedditT m)

Defined in Network.Reddit.Types

Methods

pure :: a -> RedditT m a

(<*>) :: RedditT m (a -> b) -> RedditT m a -> RedditT m b

liftA2 :: (a -> b -> c) -> RedditT m a -> RedditT m b -> RedditT m c

(*>) :: RedditT m a -> RedditT m b -> RedditT m b

(<*) :: RedditT m a -> RedditT m b -> RedditT m a

MonadIO m => MonadIO (RedditT m)

Defined in Network.Reddit.Types

Methods

liftIO :: IO a -> RedditT m a

MonadUnliftIO m => MonadUnliftIO (RedditT m)

Defined in Network.Reddit.Types

Methods

withRunInIO :: ((forall a. RedditT m a -> IO a) -> IO b) -> RedditT m b

MonadThrow m => MonadThrow (RedditT m)

Defined in Network.Reddit.Types

Methods

throwM :: Exception e => e -> RedditT m a

MonadCatch m => MonadCatch (RedditT m)

Defined in Network.Reddit.Types

Methods

catch :: Exception e => RedditT m a -> (e -> RedditT m a) -> RedditT m a

data Client

A client facilitating access to Reddit's API

Constructors

Client AuthConfig Manager (IORef ClientState) (Maybe TokenManager)

Instances

Generic Client

Defined in Network.Reddit.Types

Associated Types

type Rep Client :: Type -> Type

Methods

from :: Client -> Rep Client x

to :: Rep Client x -> Client

HasHttpManager Client

Defined in Network.Reddit.Types

Methods

getHttpManager :: Client -> Manager

Monad m => MonadReader Client (RedditT m)

Defined in Network.Reddit.Types

Methods

ask :: RedditT m Client

local :: (Client -> Client) -> RedditT m a -> RedditT m a

reader :: (Client -> a) -> RedditT m a

type Rep Client

Defined in Network.Reddit.Types

type Rep Client = D1 ('MetaData "Client" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "Client" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthConfig) :*: S1 ('MetaSel ('Just "manager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Manager)) :*: (S1 ('MetaSel ('Just "clientState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (IORef ClientState)) :*: S1 ('MetaSel ('Just "tokenManager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TokenManager)))))

data RateLimits

Rate limit info

Constructors

RateLimits Integer Integer POSIXTime POSIXTime

Instances

Eq RateLimits

Defined in Network.Reddit.Types

Methods

(==) :: RateLimits -> RateLimits -> Bool

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

Show RateLimits

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> RateLimits -> ShowS

show :: RateLimits -> String

showList :: [RateLimits] -> ShowS

Generic RateLimits

Defined in Network.Reddit.Types

Associated Types

type Rep RateLimits :: Type -> Type

Methods

from :: RateLimits -> Rep RateLimits x

to :: Rep RateLimits x -> RateLimits

type Rep RateLimits

Defined in Network.Reddit.Types

type Rep RateLimits = D1 ('MetaData "RateLimits" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "RateLimits" 'PrefixI 'True) ((S1 ('MetaSel ('Just "remaining") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "used") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "reset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIXTime) :*: S1 ('MetaSel ('Just "nextRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIXTime))))

data Listing t a

Certain API endpoints are listings, which can be paginated and filtered using a Paginator

Constructors

Listing (Maybe t) (Maybe t) (Seq a)

Instances

(Eq t, Eq a) => Eq (Listing t a)

Defined in Network.Reddit.Types.Internal

Methods

(==) :: Listing t a -> Listing t a -> Bool

(/=) :: Listing t a -> Listing t a -> Bool

(Show t, Show a) => Show (Listing t a)

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> Listing t a -> ShowS

show :: Listing t a -> String

showList :: [Listing t a] -> ShowS

Generic (Listing t a)

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep (Listing t a) :: Type -> Type

Methods

from :: Listing t a -> Rep (Listing t a) x

to :: Rep (Listing t a) x -> Listing t a

Ord t => Semigroup (Listing t a)

Defined in Network.Reddit.Types.Internal

Methods

(<>) :: Listing t a -> Listing t a -> Listing t a

sconcat :: NonEmpty (Listing t a) -> Listing t a

stimes :: Integral b => b -> Listing t a -> Listing t a

Ord t => Monoid (Listing t a)

Defined in Network.Reddit.Types.Internal

Methods

mempty :: Listing t a

mappend :: Listing t a -> Listing t a -> Listing t a

mconcat :: [Listing t a] -> Listing t a

(FromJSON a, FromJSON t) => FromJSON (Listing t a)

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser (Listing t a)

parseJSONList :: Value -> Parser [Listing t a]

type Rep (Listing t a)

Defined in Network.Reddit.Types.Internal

type Rep (Listing t a) = D1 ('MetaData "Listing" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "Listing" 'PrefixI 'True) (S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe t)) :*: (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe t)) :*: S1 ('MetaSel ('Just "children") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq a)))))

data Paginator t a

This represents the protocol that Reddit uses to control paginating and filtering entries. These can be applied to Listing endpoints. The first four fields below are common parameters that are applied to each Listing. The opts field takes extended PaginateOptions based on the second type parameter

Constructors

Paginator (Maybe t) (Maybe t) Word Bool Bool (PaginateOptions a)

Instances

(HasField' name (Paginator t a) s, a ~ b, s ~ u) => HasField name (Paginator t a) (Paginator t b) s u

Defined in Network.Reddit.Types.Internal

Methods

field :: Lens (Paginator t a) (Paginator t b) s u

(Eq t, Eq (PaginateOptions a)) => Eq (Paginator t a)

Defined in Network.Reddit.Types.Internal

Methods

(==) :: Paginator t a -> Paginator t a -> Bool

(/=) :: Paginator t a -> Paginator t a -> Bool

(Show t, Show (PaginateOptions a)) => Show (Paginator t a)

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> Paginator t a -> ShowS

show :: Paginator t a -> String

showList :: [Paginator t a] -> ShowS

Generic (Paginator t a)

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep (Paginator t a) :: Type -> Type

Methods

from :: Paginator t a -> Rep (Paginator t a) x

to :: Rep (Paginator t a) x -> Paginator t a

(Thing t, Paginable a) => ToForm (Paginator t a)

Defined in Network.Reddit.Types.Internal

Methods

toForm :: Paginator t a -> Form

type Rep (Paginator t a)

Defined in Network.Reddit.Types.Internal

type Rep (Paginator t a) = D1 ('MetaData "Paginator" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "Paginator" 'PrefixI 'True) ((S1 ('MetaSel ('Just "before") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe t)) :*: (S1 ('MetaSel ('Just "after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe t)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word))) :*: (S1 ('MetaSel ('Just "showAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "srDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "opts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PaginateOptions a))))))

class Paginable a

Represents requests that can take additional options in a Paginator. This can be used to filter/sort Listing endpoints

Minimal complete definition

defaultOpts

Instances

Paginable Subreddit

Defined in Network.Reddit.Types.Subreddit

Associated Types

type PaginateOptions Subreddit

type PaginateThing Subreddit

Methods

defaultOpts :: PaginateOptions Subreddit

getFullname :: Subreddit -> PaginateThing Subreddit

optsToForm :: PaginateOptions Subreddit -> Form

Paginable Account

Defined in Network.Reddit.Types.Account

Associated Types

type PaginateOptions Account

type PaginateThing Account

Methods

defaultOpts :: PaginateOptions Account

getFullname :: Account -> PaginateThing Account

optsToForm :: PaginateOptions Account -> Form

Paginable LiveUpdate

Defined in Network.Reddit.Types.Live

Associated Types

type PaginateOptions LiveUpdate

type PaginateThing LiveUpdate

Methods

defaultOpts :: PaginateOptions LiveUpdate

getFullname :: LiveUpdate -> PaginateThing LiveUpdate

optsToForm :: PaginateOptions LiveUpdate -> Form

Paginable LiveThread

Defined in Network.Reddit.Types.Live

Associated Types

type PaginateOptions LiveThread

type PaginateThing LiveThread

Methods

defaultOpts :: PaginateOptions LiveThread

getFullname :: LiveThread -> PaginateThing LiveThread

optsToForm :: PaginateOptions LiveThread -> Form

Paginable AssignedFlair

Defined in Network.Reddit.Types.Flair

Associated Types

type PaginateOptions AssignedFlair

type PaginateThing AssignedFlair

Methods

defaultOpts :: PaginateOptions AssignedFlair

getFullname :: AssignedFlair -> PaginateThing AssignedFlair

optsToForm :: PaginateOptions AssignedFlair -> Form

Paginable Search

Defined in Network.Reddit.Types.Submission

Associated Types

type PaginateOptions Search

type PaginateThing Search

Methods

defaultOpts :: PaginateOptions Search

getFullname :: Search -> PaginateThing Search

optsToForm :: PaginateOptions Search -> Form

Paginable Submission

Defined in Network.Reddit.Types.Submission

Associated Types

type PaginateOptions Submission

type PaginateThing Submission

Methods

defaultOpts :: PaginateOptions Submission

getFullname :: Submission -> PaginateThing Submission

optsToForm :: PaginateOptions Submission -> Form

Paginable Comment

Defined in Network.Reddit.Types.Comment

Associated Types

type PaginateOptions Comment

type PaginateThing Comment

Methods

defaultOpts :: PaginateOptions Comment

getFullname :: Comment -> PaginateThing Comment

optsToForm :: PaginateOptions Comment -> Form

Paginable Message

Defined in Network.Reddit.Types.Message

Associated Types

type PaginateOptions Message

type PaginateThing Message

Methods

defaultOpts :: PaginateOptions Message

getFullname :: Message -> PaginateThing Message

optsToForm :: PaginateOptions Message -> Form

Paginable Item

Defined in Network.Reddit.Types.Item

Associated Types

type PaginateOptions Item

type PaginateThing Item

Methods

defaultOpts :: PaginateOptions Item

getFullname :: Item -> PaginateThing Item

optsToForm :: PaginateOptions Item -> Form

Paginable ModAction

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions ModAction

type PaginateThing ModAction

Methods

defaultOpts :: PaginateOptions ModAction

getFullname :: ModAction -> PaginateThing ModAction

optsToForm :: PaginateOptions ModAction -> Form

Paginable Ban

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions Ban

type PaginateThing Ban

Methods

defaultOpts :: PaginateOptions Ban

getFullname :: Ban -> PaginateThing Ban

optsToForm :: PaginateOptions Ban -> Form

Paginable MuteInfo

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions MuteInfo

type PaginateThing MuteInfo

Methods

defaultOpts :: PaginateOptions MuteInfo

getFullname :: MuteInfo -> PaginateThing MuteInfo

optsToForm :: PaginateOptions MuteInfo -> Form

Paginable RelInfo

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions RelInfo

type PaginateThing RelInfo

Methods

defaultOpts :: PaginateOptions RelInfo

getFullname :: RelInfo -> PaginateThing RelInfo

optsToForm :: PaginateOptions RelInfo -> Form

Paginable ModItem

Defined in Network.Reddit.Types.Moderation

Associated Types

type PaginateOptions ModItem

type PaginateThing ModItem

Methods

defaultOpts :: PaginateOptions ModItem

getFullname :: ModItem -> PaginateThing ModItem

optsToForm :: PaginateOptions ModItem -> Form

Paginable WikiRevision

Defined in Network.Reddit.Types.Wiki

Associated Types

type PaginateOptions WikiRevision

type PaginateThing WikiRevision

Methods

defaultOpts :: PaginateOptions WikiRevision

getFullname :: WikiRevision -> PaginateThing WikiRevision

optsToForm :: PaginateOptions WikiRevision -> Form

data ItemOpts

Options that can be applied to comments or submissions

Constructors

ItemOpts (Maybe ItemSort) (Maybe ItemType) (Maybe Time) (Maybe Word)

Instances

Eq ItemOpts

Defined in Network.Reddit.Types.Internal

Methods

(==) :: ItemOpts -> ItemOpts -> Bool

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

Show ItemOpts

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> ItemOpts -> ShowS

show :: ItemOpts -> String

showList :: [ItemOpts] -> ShowS

Generic ItemOpts

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep ItemOpts :: Type -> Type

Methods

from :: ItemOpts -> Rep ItemOpts x

to :: Rep ItemOpts x -> ItemOpts

ToForm ItemOpts

Defined in Network.Reddit.Types.Internal

Methods

toForm :: ItemOpts -> Form

type Rep ItemOpts

Defined in Network.Reddit.Types.Internal

type Rep ItemOpts = D1 ('MetaData "ItemOpts" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "ItemOpts" 'PrefixI 'True) ((S1 ('MetaSel ('Just "itemSort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ItemSort)) :*: S1 ('MetaSel ('Just "itemType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ItemType))) :*: (S1 ('MetaSel ('Just "itemTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Time)) :*: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Word)))))

defaultItemOpts :: ItemOpts

Defaults for fetching items, like comments or submissions

data ItemSort

How to sort items in certain Listings. Not every option is guaranteed to be accepted by a given endpoint

Constructors

Hot

New

Top

Controversial

Old

Random

QA

Live

Confidence

Instances

Eq ItemSort

Defined in Network.Reddit.Types.Internal

Methods

(==) :: ItemSort -> ItemSort -> Bool

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

Show ItemSort

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> ItemSort -> ShowS

show :: ItemSort -> String

showList :: [ItemSort] -> ShowS

Generic ItemSort

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep ItemSort :: Type -> Type

Methods

from :: ItemSort -> Rep ItemSort x

to :: Rep ItemSort x -> ItemSort

ToJSON ItemSort

Defined in Network.Reddit.Types.Internal

Methods

toJSON :: ItemSort -> Value

toEncoding :: ItemSort -> Encoding

toJSONList :: [ItemSort] -> Value

toEncodingList :: [ItemSort] -> Encoding

FromJSON ItemSort

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser ItemSort

parseJSONList :: Value -> Parser [ItemSort]

ToHttpApiData ItemSort

Defined in Network.Reddit.Types.Internal

Methods

toUrlPiece :: ItemSort -> Text

toEncodedUrlPiece :: ItemSort -> Builder

toHeader :: ItemSort -> ByteString

toQueryParam :: ItemSort -> Text

type Rep ItemSort

Defined in Network.Reddit.Types.Internal

type Rep ItemSort = D1 ('MetaData "ItemSort" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (((C1 ('MetaCons "Hot" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "New" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Top" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Controversial" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Old" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Random" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "QA" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Live" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Confidence" 'PrefixI 'False) (U1 :: Type -> Type)))))

data ItemReport

A user- or moderator-generated report on a submission

Constructors

ItemReport Text Word

Instances

Eq ItemReport

Defined in Network.Reddit.Types.Internal

Methods

(==) :: ItemReport -> ItemReport -> Bool

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

Show ItemReport

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> ItemReport -> ShowS

show :: ItemReport -> String

showList :: [ItemReport] -> ShowS

Generic ItemReport

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep ItemReport :: Type -> Type

Methods

from :: ItemReport -> Rep ItemReport x

to :: Rep ItemReport x -> ItemReport

FromJSON ItemReport

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser ItemReport

parseJSONList :: Value -> Parser [ItemReport]

type Rep ItemReport

Defined in Network.Reddit.Types.Internal

type Rep ItemReport = D1 ('MetaData "ItemReport" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "ItemReport" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word)))

data Distinction

Sigils that a moderator can add to distinguish comments or submissions. Note that the Admin and Special distinctions require special privileges to use

Constructors

Moderator

Adds "[M]"

Undistinguished

Removes an existing distinction when sent

Admin

Adds "[A]"

Special

User-specific distinction

Instances

Eq Distinction

Defined in Network.Reddit.Types.Internal

Methods

(==) :: Distinction -> Distinction -> Bool

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

Show Distinction

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> Distinction -> ShowS

show :: Distinction -> String

showList :: [Distinction] -> ShowS

Generic Distinction

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep Distinction :: Type -> Type

Methods

from :: Distinction -> Rep Distinction x

to :: Rep Distinction x -> Distinction

FromJSON Distinction

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser Distinction

parseJSONList :: Value -> Parser [Distinction]

ToHttpApiData Distinction

Defined in Network.Reddit.Types.Internal

Methods

toUrlPiece :: Distinction -> Text

toEncodedUrlPiece :: Distinction -> Builder

toHeader :: Distinction -> ByteString

toQueryParam :: Distinction -> Text

type Rep Distinction

Defined in Network.Reddit.Types.Internal

type Rep Distinction = D1 ('MetaData "Distinction" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) ((C1 ('MetaCons "Moderator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Undistinguished" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Admin" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Special" 'PrefixI 'False) (U1 :: Type -> Type)))

data Time

Time range when fetching comments or submissions

Constructors

Hour

Day

Week

Month

Year

AllTime

Instances

Eq Time

Defined in Network.Reddit.Types.Internal

Methods

(==) :: Time -> Time -> Bool

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

Show Time

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> Time -> ShowS

show :: Time -> String

showList :: [Time] -> ShowS

Generic Time

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep Time :: Type -> Type

Methods

from :: Time -> Rep Time x

to :: Rep Time x -> Time

ToHttpApiData Time

Defined in Network.Reddit.Types.Internal

Methods

toUrlPiece :: Time -> Text

toEncodedUrlPiece :: Time -> Builder

toHeader :: Time -> ByteString

toQueryParam :: Time -> Text

type Rep Time

Defined in Network.Reddit.Types.Internal

type Rep Time = D1 ('MetaData "Time" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) ((C1 ('MetaCons "Hour" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Day" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Week" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Month" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Year" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AllTime" 'PrefixI 'False) (U1 :: Type -> Type))))

data ItemType

Type of comments, for filtering in Listings

Constructors

Comments

Submissions

Instances

Eq ItemType

Defined in Network.Reddit.Types.Internal

Methods

(==) :: ItemType -> ItemType -> Bool

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

Show ItemType

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> ItemType -> ShowS

show :: ItemType -> String

showList :: [ItemType] -> ShowS

Generic ItemType

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep ItemType :: Type -> Type

Methods

from :: ItemType -> Rep ItemType x

to :: Rep ItemType x -> ItemType

ToHttpApiData ItemType

Defined in Network.Reddit.Types.Internal

Methods

toUrlPiece :: ItemType -> Text

toEncodedUrlPiece :: ItemType -> Builder

toHeader :: ItemType -> ByteString

toQueryParam :: ItemType -> Text

type Rep ItemType

Defined in Network.Reddit.Types.Internal

type Rep ItemType = D1 ('MetaData "ItemType" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "Comments" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Submissions" 'PrefixI 'False) (U1 :: Type -> Type))

data UploadURL

A URL pointing to a resource hosted by Reddit. These should only be obtained by parsing the JSON of existing resources or through particular actions that perform the upload transaction and return the URL, e.g. uploadWidgetImage

Instances

Eq UploadURL

Defined in Network.Reddit.Types.Internal

Methods

(==) :: UploadURL -> UploadURL -> Bool

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

Show UploadURL

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> UploadURL -> ShowS

show :: UploadURL -> String

showList :: [UploadURL] -> ShowS

Generic UploadURL

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep UploadURL :: Type -> Type

Methods

from :: UploadURL -> Rep UploadURL x

to :: Rep UploadURL x -> UploadURL

ToJSON UploadURL

Defined in Network.Reddit.Types.Internal

Methods

toJSON :: UploadURL -> Value

toEncoding :: UploadURL -> Encoding

toJSONList :: [UploadURL] -> Value

toEncodingList :: [UploadURL] -> Encoding

FromJSON UploadURL

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser UploadURL

parseJSONList :: Value -> Parser [UploadURL]

ToHttpApiData UploadURL

Defined in Network.Reddit.Types.Internal

Methods

toUrlPiece :: UploadURL -> Text

toEncodedUrlPiece :: UploadURL -> Builder

toHeader :: UploadURL -> ByteString

toQueryParam :: UploadURL -> Text

type Rep UploadURL

Defined in Network.Reddit.Types.Internal

type Rep UploadURL = D1 ('MetaData "UploadURL" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'True) (C1 ('MetaCons "UploadURL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 URL)))

type Body = Text

Type synonym for bodies of submissions, comments, messages, etc...

type Title = Text

Type synonym for titles of submissions, etc...

type URL = Text

Type synonym for URLs

type Subject = Text

Type synonym for subjects of messages, etc...

type RGBText = Text

Type synonym RGB color strings

type Name = Text

Type synonym for names of items

type Domain = Text

Type synonym for domains

type Modifier = [Char] -> [Char]

Type synonym for fieldLabelModifiers in FromJSON instances

Exceptions

data RedditException

Base exception type for Reddit API client

Instances

Show RedditException

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> RedditException -> ShowS

show :: RedditException -> String

showList :: [RedditException] -> ShowS

Exception RedditException

Defined in Network.Reddit.Types.Internal

Methods

toException :: RedditException -> SomeException

fromException :: SomeException -> Maybe RedditException

displayException :: RedditException -> String

data ClientException

Exceptions generated within the Reddit API client

Constructors

InvalidRequest Text

InvalidResponse Text

MalformedCredentials Text

OtherError Text

ConfigurationError Text

Instances

Eq ClientException

Defined in Network.Reddit.Types.Internal

Methods

(==) :: ClientException -> ClientException -> Bool

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

Show ClientException

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> ClientException -> ShowS

show :: ClientException -> String

showList :: [ClientException] -> ShowS

Generic ClientException

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep ClientException :: Type -> Type

Methods

from :: ClientException -> Rep ClientException x

to :: Rep ClientException x -> ClientException

Exception ClientException

Defined in Network.Reddit.Types.Internal

Methods

toException :: ClientException -> SomeException

fromException :: SomeException -> Maybe ClientException

displayException :: ClientException -> String

type Rep ClientException

Defined in Network.Reddit.Types.Internal

type Rep ClientException = D1 ('MetaData "ClientException" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) ((C1 ('MetaCons "InvalidRequest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "InvalidResponse" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :+: (C1 ('MetaCons "MalformedCredentials" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "OtherError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "ConfigurationError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

data APIException

Exceptions returned from API endpoints

Constructors

ErrorWithStatus StatusMessage

ErrorWithMessage ErrorMessage

InvalidCredentials OAauthError

InvalidPOST POSTError

Sent if errors occur when posting JSON

JSONParseError Text ByteString

With the response body, for further debugging

Redirected (Maybe Request)

If the API action should not allow automatic redirects, this error returns the possible redirected request

WebsocketError Text SomeException

Thrown when exceptions occur during websocket handling

UploadFailed

When an error occurs uploading media to Reddit's servers

Instances

Show APIException

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> APIException -> ShowS

show :: APIException -> String

showList :: [APIException] -> ShowS

Generic APIException

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep APIException :: Type -> Type

Methods

from :: APIException -> Rep APIException x

to :: Rep APIException x -> APIException

FromJSON APIException

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser APIException

parseJSONList :: Value -> Parser [APIException]

Exception APIException

Defined in Network.Reddit.Types.Internal

Methods

toException :: APIException -> SomeException

fromException :: SomeException -> Maybe APIException

displayException :: APIException -> String

type Rep APIException

Defined in Network.Reddit.Types.Internal

type Rep APIException = D1 ('MetaData "APIException" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (((C1 ('MetaCons "ErrorWithStatus" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StatusMessage)) :+: C1 ('MetaCons "ErrorWithMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ErrorMessage))) :+: (C1 ('MetaCons "InvalidCredentials" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OAauthError)) :+: C1 ('MetaCons "InvalidPOST" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSTError)))) :+: ((C1 ('MetaCons "JSONParseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)) :+: C1 ('MetaCons "Redirected" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Request)))) :+: (C1 ('MetaCons "WebsocketError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SomeException)) :+: C1 ('MetaCons "UploadFailed" 'PrefixI 'False) (U1 :: Type -> Type))))

data OAauthError

An error which occurs when attempting to authenticate via OAuth

Constructors

OAauthError Text (Maybe Text)

Instances

Eq OAauthError

Defined in Network.Reddit.Types.Internal

Methods

(==) :: OAauthError -> OAauthError -> Bool

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

Show OAauthError

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> OAauthError -> ShowS

show :: OAauthError -> String

showList :: [OAauthError] -> ShowS

Generic OAauthError

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep OAauthError :: Type -> Type

Methods

from :: OAauthError -> Rep OAauthError x

to :: Rep OAauthError x -> OAauthError

FromJSON OAauthError

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser OAauthError

parseJSONList :: Value -> Parser [OAauthError]

type Rep OAauthError

Defined in Network.Reddit.Types.Internal

type Rep OAauthError = D1 ('MetaData "OAauthError" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "OAauthError" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

data ErrorMessage

A specific error message

Constructors

EmptyError

OtherErrorMessage [Value]

Ratelimited Integer Text

CommentDeleted

BadSRName

SubredditNotExists

SubredditRequired

AlreadySubmitted

NoURL

NoName

NoText

TooShort

BadCaptcha

UserRequired

InsufficientCoins

Instances

Eq ErrorMessage

Defined in Network.Reddit.Types.Internal

Methods

(==) :: ErrorMessage -> ErrorMessage -> Bool

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

Show ErrorMessage

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> ErrorMessage -> ShowS

show :: ErrorMessage -> String

showList :: [ErrorMessage] -> ShowS

Generic ErrorMessage

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep ErrorMessage :: Type -> Type

Methods

from :: ErrorMessage -> Rep ErrorMessage x

to :: Rep ErrorMessage x -> ErrorMessage

FromJSON ErrorMessage

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser ErrorMessage

parseJSONList :: Value -> Parser [ErrorMessage]

type Rep ErrorMessage

Defined in Network.Reddit.Types.Internal

type Rep ErrorMessage = D1 ('MetaData "ErrorMessage" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (((C1 ('MetaCons "EmptyError" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OtherErrorMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Value])) :+: C1 ('MetaCons "Ratelimited" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :+: ((C1 ('MetaCons "CommentDeleted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BadSRName" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SubredditNotExists" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SubredditRequired" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "AlreadySubmitted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoURL" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NoName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoText" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "TooShort" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BadCaptcha" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UserRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InsufficientCoins" 'PrefixI 'False) (U1 :: Type -> Type)))))

data StatusMessage

Details about a non-200 HTTP response

Constructors

StatusMessage StatusCode Text

Instances

Eq StatusMessage

Defined in Network.Reddit.Types.Internal

Methods

(==) :: StatusMessage -> StatusMessage -> Bool

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

Show StatusMessage

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> StatusMessage -> ShowS

show :: StatusMessage -> String

showList :: [StatusMessage] -> ShowS

Generic StatusMessage

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep StatusMessage :: Type -> Type

Methods

from :: StatusMessage -> Rep StatusMessage x

to :: Rep StatusMessage x -> StatusMessage

FromJSON StatusMessage

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser StatusMessage

parseJSONList :: Value -> Parser [StatusMessage]

type Rep StatusMessage

Defined in Network.Reddit.Types.Internal

type Rep StatusMessage = D1 ('MetaData "StatusMessage" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "StatusMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StatusCode) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

type StatusCode = Int

Type synonym for status codes in responses

data POSTError

Details about a non-200 response when sending a POST request

Constructors

POSTError [Text] Text Text Text

Instances

Eq POSTError

Defined in Network.Reddit.Types.Internal

Methods

(==) :: POSTError -> POSTError -> Bool

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

Show POSTError

Defined in Network.Reddit.Types.Internal

Methods

showsPrec :: Int -> POSTError -> ShowS

show :: POSTError -> String

showList :: [POSTError] -> ShowS

Generic POSTError

Defined in Network.Reddit.Types.Internal

Associated Types

type Rep POSTError :: Type -> Type

Methods

from :: POSTError -> Rep POSTError x

to :: Rep POSTError x -> POSTError

FromJSON POSTError

Defined in Network.Reddit.Types.Internal

Methods

parseJSON :: Value -> Parser POSTError

parseJSONList :: Value -> Parser [POSTError]

type Rep POSTError

Defined in Network.Reddit.Types.Internal

type Rep POSTError = D1 ('MetaData "POSTError" "Network.Reddit.Types.Internal" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "POSTError" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "explanation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

Auth

data ClientState

Stateful data that may be updated over the course of a Client lifetime

Instances

Eq ClientState

Defined in Network.Reddit.Types

Methods

(==) :: ClientState -> ClientState -> Bool

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

Show ClientState

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> ClientState -> ShowS

show :: ClientState -> String

showList :: [ClientState] -> ShowS

Generic ClientState

Defined in Network.Reddit.Types

Associated Types

type Rep ClientState :: Type -> Type

Methods

from :: ClientState -> Rep ClientState x

to :: Rep ClientState x -> ClientState

type Rep ClientState

Defined in Network.Reddit.Types

type Rep ClientState = D1 ('MetaData "ClientState" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "ClientState" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessToken) :*: (S1 ('MetaSel ('Just "tokenObtained") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIXTime) :*: S1 ('MetaSel ('Just "limits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RateLimits)))))

data AppType

The three forms of application that may use the Reddit API, each having different API access patterns

Constructors

ScriptApp ClientSecret PasswordFlow

The simplest type of application. May only be used by the developer who owns the account. This requires supplying the usernme and password associated with the account

WebApp ClientSecret CodeFlow

For applications running on a server backend

InstalledApp CodeFlow

For applications installed on devices that the developer does not own (e.g., a mobile application)

ApplicationOnly ClientSecret

Instances

Eq AppType

Defined in Network.Reddit.Types

Methods

(==) :: AppType -> AppType -> Bool

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

Show AppType

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> AppType -> ShowS

show :: AppType -> String

showList :: [AppType] -> ShowS

Generic AppType

Defined in Network.Reddit.Types

Associated Types

type Rep AppType :: Type -> Type

Methods

from :: AppType -> Rep AppType x

to :: Rep AppType x -> AppType

ToForm AppType

Defined in Network.Reddit.Types

Methods

toForm :: AppType -> Form

type Rep AppType

Defined in Network.Reddit.Types

type Rep AppType = D1 ('MetaData "AppType" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) ((C1 ('MetaCons "ScriptApp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientSecret) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PasswordFlow)) :+: C1 ('MetaCons "WebApp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientSecret) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeFlow))) :+: (C1 ('MetaCons "InstalledApp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeFlow)) :+: C1 ('MetaCons "ApplicationOnly" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientSecret))))

data AuthConfig

A configuration

Constructors

AuthConfig ClientID AppType UserAgent

Instances

Eq AuthConfig

Defined in Network.Reddit.Types

Methods

(==) :: AuthConfig -> AuthConfig -> Bool

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

Show AuthConfig

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> AuthConfig -> ShowS

show :: AuthConfig -> String

showList :: [AuthConfig] -> ShowS

Generic AuthConfig

Defined in Network.Reddit.Types

Associated Types

type Rep AuthConfig :: Type -> Type

Methods

from :: AuthConfig -> Rep AuthConfig x

to :: Rep AuthConfig x -> AuthConfig

type Rep AuthConfig

Defined in Network.Reddit.Types

type Rep AuthConfig = D1 ('MetaData "AuthConfig" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "AuthConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientID) :*: (S1 ('MetaSel ('Just "appType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppType) :*: S1 ('MetaSel ('Just "userAgent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserAgent))))

data UserAgent

A unique user agent to identify your application; Reddit applies rate-limiting to common agents, and actively bans misleading ones

Constructors

UserAgent Text Text Text Text

Instances

Eq UserAgent

Defined in Network.Reddit.Types

Methods

(==) :: UserAgent -> UserAgent -> Bool

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

Show UserAgent

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> UserAgent -> ShowS

show :: UserAgent -> String

showList :: [UserAgent] -> ShowS

Generic UserAgent

Defined in Network.Reddit.Types

Associated Types

type Rep UserAgent :: Type -> Type

Methods

from :: UserAgent -> Rep UserAgent x

to :: Rep UserAgent x -> UserAgent

type Rep UserAgent

Defined in Network.Reddit.Types

type Rep UserAgent = D1 ('MetaData "UserAgent" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "UserAgent" 'PrefixI 'True) ((S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "appID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

data AccessToken

Token received after authentication

Constructors

AccessToken Token NominalDiffTime [Scope] (Maybe Token)

Instances

Eq AccessToken

Defined in Network.Reddit.Types

Methods

(==) :: AccessToken -> AccessToken -> Bool

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

Show AccessToken

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> AccessToken -> ShowS

show :: AccessToken -> String

showList :: [AccessToken] -> ShowS

Generic AccessToken

Defined in Network.Reddit.Types

Associated Types

type Rep AccessToken :: Type -> Type

Methods

from :: AccessToken -> Rep AccessToken x

to :: Rep AccessToken x -> AccessToken

FromJSON AccessToken

Defined in Network.Reddit.Types

Methods

parseJSON :: Value -> Parser AccessToken

parseJSONList :: Value -> Parser [AccessToken]

type Rep AccessToken

Defined in Network.Reddit.Types

type Rep AccessToken = D1 ('MetaData "AccessToken" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "AccessToken" 'PrefixI 'True) ((S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Token) :*: S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NominalDiffTime)) :*: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Scope]) :*: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Token)))))

type Token = Text

Type synonym for the text of a token

type Code = Text

Type synonym for the text of codes returned from auth URLs, for WebApps and InstalledApps

data Scope

Represents a specific Reddit functionality that must be explicitly requested

Constructors

Accounts

Corresponds to "account" in text form

Creddits

Edit

Flair

History

Identity

LiveManage

ModConfig

ModContributors

ModFlair

ModLog

ModMail

ModOthers

ModPosts

ModSelf

ModTraffic

ModWiki

MySubreddits

PrivateMessages

Read

Report

Save

StructuredStyles

Submit

Subscribe

Vote

WikiEdit

WikiRead

Unlimited

For all scopes, corresponds to "*"

Instances

Enum Scope

Defined in Network.Reddit.Types

Methods

succ :: Scope -> Scope

pred :: Scope -> Scope

toEnum :: Int -> Scope

fromEnum :: Scope -> Int

enumFrom :: Scope -> [Scope]

enumFromThen :: Scope -> Scope -> [Scope]

enumFromTo :: Scope -> Scope -> [Scope]

enumFromThenTo :: Scope -> Scope -> Scope -> [Scope]

Eq Scope

Defined in Network.Reddit.Types

Methods

(==) :: Scope -> Scope -> Bool

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

Ord Scope

Defined in Network.Reddit.Types

Methods

compare :: Scope -> Scope -> Ordering

(<) :: Scope -> Scope -> Bool

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

(>) :: Scope -> Scope -> Bool

(>=) :: Scope -> Scope -> Bool

max :: Scope -> Scope -> Scope

min :: Scope -> Scope -> Scope

Show Scope

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

Generic Scope

Defined in Network.Reddit.Types

Associated Types

type Rep Scope :: Type -> Type

Methods

from :: Scope -> Rep Scope x

to :: Rep Scope x -> Scope

FromJSON Scope

Defined in Network.Reddit.Types

Methods

parseJSON :: Value -> Parser Scope

parseJSONList :: Value -> Parser [Scope]

ToHttpApiData Scope

Defined in Network.Reddit.Types

Methods

toUrlPiece :: Scope -> Text

toEncodedUrlPiece :: Scope -> Builder

toHeader :: Scope -> ByteString

toQueryParam :: Scope -> Text

type Rep Scope

Defined in Network.Reddit.Types

type Rep Scope = D1 ('MetaData "Scope" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) ((((C1 ('MetaCons "Accounts" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Creddits" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Edit" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Flair" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "History" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Identity" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LiveManage" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "ModConfig" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ModContributors" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModFlair" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ModLog" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModMail" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ModOthers" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModPosts" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "ModSelf" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ModTraffic" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ModWiki" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "MySubreddits" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PrivateMessages" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Read" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Report" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "Save" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StructuredStyles" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Submit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Subscribe" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Vote" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WikiEdit" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "WikiRead" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unlimited" 'PrefixI 'False) (U1 :: Type -> Type))))))

data PasswordFlow

Simple user credentials for authenticating via ScriptApps

Note: These credentials will be kept in memory!

Constructors

PasswordFlow Text Text

Instances

Eq PasswordFlow

Defined in Network.Reddit.Types

Methods

(==) :: PasswordFlow -> PasswordFlow -> Bool

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

Show PasswordFlow

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> PasswordFlow -> ShowS

show :: PasswordFlow -> String

showList :: [PasswordFlow] -> ShowS

Generic PasswordFlow

Defined in Network.Reddit.Types

Associated Types

type Rep PasswordFlow :: Type -> Type

Methods

from :: PasswordFlow -> Rep PasswordFlow x

to :: Rep PasswordFlow x -> PasswordFlow

ToForm PasswordFlow

Defined in Network.Reddit.Types

Methods

toForm :: PasswordFlow -> Form

type Rep PasswordFlow

Defined in Network.Reddit.Types

type Rep PasswordFlow = D1 ('MetaData "PasswordFlow" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "PasswordFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

data CodeFlow

Details for OAuth "code flow", for WebApps and InstalledApps

Constructors

CodeFlow URL Code

Instances

Eq CodeFlow

Defined in Network.Reddit.Types

Methods

(==) :: CodeFlow -> CodeFlow -> Bool

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

Show CodeFlow

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> CodeFlow -> ShowS

show :: CodeFlow -> String

showList :: [CodeFlow] -> ShowS

Generic CodeFlow

Defined in Network.Reddit.Types

Associated Types

type Rep CodeFlow :: Type -> Type

Methods

from :: CodeFlow -> Rep CodeFlow x

to :: Rep CodeFlow x -> CodeFlow

ToForm CodeFlow

Defined in Network.Reddit.Types

Methods

toForm :: CodeFlow -> Form

type Rep CodeFlow

Defined in Network.Reddit.Types

type Rep CodeFlow = D1 ('MetaData "CodeFlow" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "CodeFlow" 'PrefixI 'True) (S1 ('MetaSel ('Just "redirectURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 URL) :*: S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Code)))

type ClientID = Text

Type synonym for client IDs

type ClientSecret = Text

Type synonym for client secrets

data TokenDuration

The duration of the access token for WebApps and InstalledApps

Constructors

Temporary

Generates one-hour access tokens without a refresh token

Permanent

Generates a one-hour access tokens with a refresh token that can be used to indefinitely obtain new access tokens

Instances

Eq TokenDuration

Defined in Network.Reddit.Types

Methods

(==) :: TokenDuration -> TokenDuration -> Bool

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

Show TokenDuration

Defined in Network.Reddit.Types

Methods

showsPrec :: Int -> TokenDuration -> ShowS

show :: TokenDuration -> String

showList :: [TokenDuration] -> ShowS

Generic TokenDuration

Defined in Network.Reddit.Types

Associated Types

type Rep TokenDuration :: Type -> Type

Methods

from :: TokenDuration -> Rep TokenDuration x

to :: Rep TokenDuration x -> TokenDuration

ToHttpApiData TokenDuration

Defined in Network.Reddit.Types

Methods

toUrlPiece :: TokenDuration -> Text

toEncodedUrlPiece :: TokenDuration -> Builder

toHeader :: TokenDuration -> ByteString

toQueryParam :: TokenDuration -> Text

type Rep TokenDuration

Defined in Network.Reddit.Types

type Rep TokenDuration = D1 ('MetaData "TokenDuration" "Network.Reddit.Types" "heddit-0.1-70ReOU8uVjwHwPvCNnDeID" 'False) (C1 ('MetaCons "Temporary" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Permanent" 'PrefixI 'False) (U1 :: Type -> Type))

Re-exports

Only modules covering basic functionality are re-exported, including those for users, subreddits, submissions, comments, and actions for the authenticated user. For actions and types touching on moderation, collections, live threads, and more, import the respective modules directly

module Network.Reddit.User

module Network.Reddit.Subreddit

module Network.Reddit.Submission

module Network.Reddit.Me

module Network.Reddit.Comment