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

Contents

Reddit
Auth
Requests
Re-exports

Description

Synopsis

data RedditT m a
runRedditT :: Client -> RedditT m a -> m a
type MonadReddit m = (MonadUnliftIO m, MonadThrow m, MonadCatch m, MonadReader Client m)
data UserAgent = UserAgent {
- platform :: Text
- appID :: Text
- version :: Text
- author :: Text
}
type ClientSite = Text
data Client = Client {
- authConfig :: AuthConfig
- manager :: Manager
- clientState :: IORef ClientState
- tokenManager :: Maybe TokenManager
}
data ClientState = ClientState {
- accessToken :: AccessToken
- tokenObtained :: POSIXTime
- limits :: Maybe RateLimits
}
readClientState :: MonadReddit m => Lens' ClientState a -> m a
data WithData
- = WithJSON Value
- | WithForm Form
- | WithMultipart [Part]
- | NoData
data RateLimits = RateLimits {
- remaining :: Integer
- used :: Integer
- reset :: POSIXTime
- nextRequest :: POSIXTime
}
readRateLimits :: POSIXTime -> ResponseHeaders -> Maybe RateLimits
data AppType
- = ScriptApp ClientSecret PasswordFlow
- | WebApp ClientSecret CodeFlow
- | InstalledApp CodeFlow
- | ApplicationOnly ClientSecret
data AuthConfig = AuthConfig {
- clientID :: ClientID
- appType :: AppType
- userAgent :: UserAgent
}
data AccessToken = AccessToken {
- token :: Token
- expiresIn :: NominalDiffTime
- scope :: [Scope]
- refreshToken :: Maybe Token
}
type Token = Text
type Code = Text
data Scope
- = Accounts
- | 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
data PasswordFlow = PasswordFlow {
- username :: Text
- password :: Text
}
data CodeFlow = CodeFlow {
- redirectURI :: URL
- code :: Code
}
type ClientID = Text
type ClientSecret = Text
data TokenDuration
- = Temporary
- | Permanent
data TokenManager = TokenManager {
- loadToken :: forall m. (MonadIO m, MonadThrow m) => m Token
- putToken :: forall m. (MonadIO m, MonadThrow m) => Maybe Token -> m ()
}
data APIAction a = APIAction {
- method :: Method
- pathSegments :: [PathSegment]
- requestData :: WithData
- needsAuth :: Bool
- followRedirects :: Bool
- rawJSON :: Bool
- checkResponse :: Request -> Response BodyReader -> IO ()
}
data Method
- = GET
- | POST
- | DELETE
- | PUT
- | PATCH
type PathSegment = Text
module Network.Reddit.Types.Internal

Reddit

data RedditT m a Source #

The monad tranformer in which Reddit API transactions can be executed

Instances

Instances details

Monad m => MonadReader Client (RedditT m) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Network.Reddit.Types Methods liftIO :: IO a -> RedditT m a #
MonadUnliftIO m => MonadUnliftIO (RedditT m) Source #
Instance details Defined in Network.Reddit.Types Methods withRunInIO :: ((forall a. RedditT m a -> IO a) -> IO b) -> RedditT m b #
MonadThrow m => MonadThrow (RedditT m) Source #
Instance details Defined in Network.Reddit.Types Methods throwM :: Exception e => e -> RedditT m a #
MonadCatch m => MonadCatch (RedditT m) Source #
Instance details Defined in Network.Reddit.Types Methods catch :: Exception e => RedditT m a -> (e -> RedditT m a) -> RedditT m a #

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

Run a RedditT action

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

Synonym for constraints that RedditT actions must satisfy

data UserAgent Source #

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

Constructors

UserAgent
Fields platform :: Text The target platform appID :: Text A unique application ID version :: Text author :: Text Your username as contact information

Instances

Instances details

Eq UserAgent Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: UserAgent -> UserAgent -> Bool # (/=) :: UserAgent -> UserAgent -> Bool #
Show UserAgent Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> UserAgent -> ShowS # show :: UserAgent -> String # showList :: [UserAgent] -> ShowS #
Generic UserAgent Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types type Rep UserAgent = D1 ('MetaData "UserAgent" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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))))

type ClientSite = Text Source #

A client site corresponds to a field in your auth configuration ini file

data Client Source #

A client facilitating access to Reddit's API

Constructors

Client
Fields authConfig :: AuthConfig manager :: Manager clientState :: IORef ClientState tokenManager :: Maybe TokenManager

Instances

Instances details

Generic Client Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods getHttpManager :: Client -> Manager #
Monad m => MonadReader Client (RedditT m) Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types type Rep Client = D1 ('MetaData "Client" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 ClientState Source #

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

Constructors

ClientState
Fields accessToken :: AccessToken tokenObtained :: POSIXTime The approximate time at which the token was obtained. This is useful to compare against the `expiresIn` field of the `AccessToken` limits :: Maybe RateLimits

Instances

Instances details

Eq ClientState Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: ClientState -> ClientState -> Bool # (/=) :: ClientState -> ClientState -> Bool #
Show ClientState Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> ClientState -> ShowS # show :: ClientState -> String # showList :: [ClientState] -> ShowS #
Generic ClientState Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types type Rep ClientState = D1 ('MetaData "ClientState" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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)))))

readClientState :: MonadReddit m => Lens' ClientState a -> m a Source #

For conveniently reading some field from the IORef ClientState inside a Client

data WithData Source #

Data, either as JSON or URL-encoded form, to be attached to requests

Constructors

WithJSON Value
WithForm Form
WithMultipart [Part]
NoData

Instances

Instances details

Show WithData Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> WithData -> ShowS # show :: WithData -> String # showList :: [WithData] -> ShowS #
Generic WithData Source #
Instance details Defined in Network.Reddit.Types Associated Types type Rep WithData :: Type -> Type # Methods from :: WithData -> Rep WithData x # to :: Rep WithData x -> WithData #
type Rep WithData Source #
Instance details Defined in Network.Reddit.Types type Rep WithData = D1 ('MetaData "WithData" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) ((C1 ('MetaCons "WithJSON" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value)) :+: C1 ('MetaCons "WithForm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Form))) :+: (C1 ('MetaCons "WithMultipart" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Part])) :+: C1 ('MetaCons "NoData" 'PrefixI 'False) (U1 :: Type -> Type)))

data RateLimits Source #

Rate limit info

Constructors

RateLimits
Fields remaining :: Integer The number of requests remaining in the current rate-limiting window used :: Integer reset :: POSIXTime Timestamp of the upper bound on rate-limiting counter reset nextRequest :: POSIXTime Epoch time at which the next request should be made in order to stay within the current rate limit bounds

Instances

Instances details

Eq RateLimits Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: RateLimits -> RateLimits -> Bool # (/=) :: RateLimits -> RateLimits -> Bool #
Show RateLimits Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> RateLimits -> ShowS # show :: RateLimits -> String # showList :: [RateLimits] -> ShowS #
Generic RateLimits Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types type Rep RateLimits = D1 ('MetaData "RateLimits" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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))))

readRateLimits :: POSIXTime -> ResponseHeaders -> Maybe RateLimits Source #

Extract rate limit info from response headers. This should only be called after making a request

Auth

data AppType Source #

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

Instances details

Eq AppType Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: AppType -> AppType -> Bool # (/=) :: AppType -> AppType -> Bool #
Show AppType Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> AppType -> ShowS # show :: AppType -> String # showList :: [AppType] -> ShowS #
Generic AppType Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods toForm :: AppType -> Form #
type Rep AppType Source #
Instance details Defined in Network.Reddit.Types type Rep AppType = D1 ('MetaData "AppType" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 Source #

A configuration

Constructors

AuthConfig
Fields clientID :: ClientID Your application's client ID appType :: AppType The type of your application. This will determine how OAuth credentials are obtained userAgent :: UserAgent Your unique user agent; will be used in the client that is obtained after authenticating

Instances

Instances details

Eq AuthConfig Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: AuthConfig -> AuthConfig -> Bool # (/=) :: AuthConfig -> AuthConfig -> Bool #
Show AuthConfig Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> AuthConfig -> ShowS # show :: AuthConfig -> String # showList :: [AuthConfig] -> ShowS #
Generic AuthConfig Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types type Rep AuthConfig = D1 ('MetaData "AuthConfig" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 AccessToken Source #

Token received after authentication

Constructors

AccessToken
Fields token :: Token expiresIn :: NominalDiffTime scope :: [Scope] refreshToken :: Maybe Token

Instances

Instances details

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

Type synonym for the text of a token

type Code = Text Source #

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

data Scope Source #

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

Instances details

Enum Scope Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Ord Scope Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #
Generic Scope Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods parseJSON :: Value -> Parser Scope # parseJSONList :: Value -> Parser [Scope] #
ToHttpApiData Scope Source #
Instance details Defined in Network.Reddit.Types Methods toUrlPiece :: Scope -> Text # toEncodedUrlPiece :: Scope -> Builder # toHeader :: Scope -> ByteString # toQueryParam :: Scope -> Text #
type Rep Scope Source #
Instance details Defined in Network.Reddit.Types type Rep Scope = D1 ('MetaData "Scope" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 Source #

Simple user credentials for authenticating via ScriptApps

Note: These credentials will be kept in memory!

Constructors

PasswordFlow
Fields username :: Text The name of the user you are authenticating as password :: Text The password of the user you are authenticating as

Instances

Instances details

Eq PasswordFlow Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: PasswordFlow -> PasswordFlow -> Bool # (/=) :: PasswordFlow -> PasswordFlow -> Bool #
Show PasswordFlow Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> PasswordFlow -> ShowS # show :: PasswordFlow -> String # showList :: [PasswordFlow] -> ShowS #
Generic PasswordFlow Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods toForm :: PasswordFlow -> Form #
type Rep PasswordFlow Source #
Instance details Defined in Network.Reddit.Types type Rep PasswordFlow = D1 ('MetaData "PasswordFlow" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 Source #

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

Constructors

CodeFlow

Fields

redirectURI :: URL
This must exactly match the redirect URL you entered when making your application on Reddit
code :: Code
This is the code that is obtained after a user grants permissions by visiting the URL generated by getAuthURL. If you are using a TokenManager with newClientWithManager, you can leave this field as empty text, since it won't be used to get the initial refresh token

Instances

Instances details

Eq CodeFlow Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: CodeFlow -> CodeFlow -> Bool # (/=) :: CodeFlow -> CodeFlow -> Bool #
Show CodeFlow Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> CodeFlow -> ShowS # show :: CodeFlow -> String # showList :: [CodeFlow] -> ShowS #
Generic CodeFlow Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods toForm :: CodeFlow -> Form #
type Rep CodeFlow Source #
Instance details Defined in Network.Reddit.Types type Rep CodeFlow = D1 ('MetaData "CodeFlow" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" '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 Source #

Type synonym for client IDs

type ClientSecret = Text Source #

Type synonym for client secrets

data TokenDuration Source #

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

Instances details

Eq TokenDuration Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: TokenDuration -> TokenDuration -> Bool # (/=) :: TokenDuration -> TokenDuration -> Bool #
Show TokenDuration Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> TokenDuration -> ShowS # show :: TokenDuration -> String # showList :: [TokenDuration] -> ShowS #
Generic TokenDuration Source #
Instance details 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 Source #
Instance details Defined in Network.Reddit.Types Methods toUrlPiece :: TokenDuration -> Text # toEncodedUrlPiece :: TokenDuration -> Builder # toHeader :: TokenDuration -> ByteString # toQueryParam :: TokenDuration -> Text #
type Rep TokenDuration Source #
Instance details Defined in Network.Reddit.Types type Rep TokenDuration = D1 ('MetaData "TokenDuration" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "Temporary" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Permanent" 'PrefixI 'False) (U1 :: Type -> Type))

data TokenManager Source #

Monadic actions to load and save Tokens, specifically refresh tokens, when creating new Clients for WebApps and InstalledApps

Constructors

TokenManager

Fields

loadToken :: forall m. (MonadIO m, MonadThrow m) => m Token
Load an existing refresh token, for instance from a file or database
putToken :: forall m. (MonadIO m, MonadThrow m) => Maybe Token -> m ()
Store the new refresh token that is received when exchanging the existing one for a new AccessToken.
This action must take a Maybe Token as its argument, as it is possible (albeit perhaps unlikely) that Reddit does not return a new token when exchanging the existing refresh token for a new access token

Requests

data APIAction a Source #

An API request parameterized by the type it evaluates to when executed

Constructors

APIAction
Fields method :: Method pathSegments :: [PathSegment] requestData :: WithData needsAuth :: Bool followRedirects :: Bool rawJSON :: Bool checkResponse :: Request -> Response BodyReader -> IO ()

Instances

Instances details

Generic (APIAction a) Source #
Instance details Defined in Network.Reddit.Types Associated Types type Rep (APIAction a) :: Type -> Type # Methods from :: APIAction a -> Rep (APIAction a) x # to :: Rep (APIAction a) x -> APIAction a #
type Rep (APIAction a) Source #
Instance details Defined in Network.Reddit.Types type Rep (APIAction a) = D1 ('MetaData "APIAction" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) (C1 ('MetaCons "APIAction" 'PrefixI 'True) ((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Method) :: (S1 ('MetaSel ('Just "pathSegments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PathSegment]) :: S1 ('MetaSel ('Just "requestData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WithData))) :: ((S1 ('MetaSel ('Just "needsAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "followRedirects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "rawJSON") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "checkResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Request -> Response BodyReader -> IO ()))))))

data Method Source #

HTTP method, excluding those not used in the Reddit API

Constructors

GET
POST
DELETE
PUT
PATCH

Instances

Instances details

Eq Method Source #
Instance details Defined in Network.Reddit.Types Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Show Method Source #
Instance details Defined in Network.Reddit.Types Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
Generic Method Source #
Instance details Defined in Network.Reddit.Types Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
type Rep Method Source #
Instance details Defined in Network.Reddit.Types type Rep Method = D1 ('MetaData "Method" "Network.Reddit.Types" "heddit-0.0.1-76ROQ5tOAm3CpLSaFw8ccb" 'False) ((C1 ('MetaCons "GET" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "POST" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DELETE" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PUT" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PATCH" 'PrefixI 'False) (U1 :: Type -> Type))))

type PathSegment = Text Source #

Type synonym for a segment of a URL path

Re-exports

module Network.Reddit.Types.Internal