Web.Pixiv.Auth

Authentication pixiv API. Users should not use logics in this module directly, since Web.Pixiv.Types.PixivT takes over token management, providing user friendly operations.

Documentation

newtype Token

A wrapped Text represents a token.

Constructors

Token

Fields

• unToken :: Text

Instances

Eq Token

Defined in Web.Pixiv.Auth

Methods

(==) :: Token -> Token -> Bool

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

Read Token

Defined in Web.Pixiv.Auth

Methods

readsPrec :: Int -> ReadS Token

readList :: ReadS [Token]

readPrec :: ReadPrec Token

readListPrec :: ReadPrec [Token]

Show Token

Defined in Web.Pixiv.Auth

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

IsString Token

Defined in Web.Pixiv.Auth

Methods

fromString :: String -> Token

ToJSON Token

Defined in Web.Pixiv.Auth

Methods

toJSON :: Token -> Value

toEncoding :: Token -> Encoding

toJSONList :: [Token] -> Value

toEncodingList :: [Token] -> Encoding

FromJSON Token

Defined in Web.Pixiv.Auth

Methods

parseJSON :: Value -> Parser Token

parseJSONList :: Value -> Parser [Token]

newtype Credential

Authentication credentials for pixiv API.

Password authentication is no longer supported by pixiv. You may consult https://github.com/upbit/pixivpy/issues/158 to get the information of how to acquire refresh token. Normally, users are supposed to create value of this data type and then pass it to runPixivT.

Constructors

RefreshToken

Fields

• cr_refreshToken :: Token

Instances

Eq Credential

Defined in Web.Pixiv.Auth

Methods

(==) :: Credential -> Credential -> Bool

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

Show Credential

Defined in Web.Pixiv.Auth

Methods

showsPrec :: Int -> Credential -> ShowS

show :: Credential -> String

showList :: [Credential] -> ShowS

data OAuth2Token

Successful result.

Constructors

OAuth2Token

Fields

• oa_accessToken :: Token
• oa_expiresIn :: Int
• oa_refreshToken :: Token

Instances

Eq OAuth2Token

Defined in Web.Pixiv.Auth

Methods

(==) :: OAuth2Token -> OAuth2Token -> Bool

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

Read OAuth2Token

Defined in Web.Pixiv.Auth

Methods

readsPrec :: Int -> ReadS OAuth2Token

readList :: ReadS [OAuth2Token]

readPrec :: ReadPrec OAuth2Token

readListPrec :: ReadPrec [OAuth2Token]

Show OAuth2Token

Defined in Web.Pixiv.Auth

Methods

showsPrec :: Int -> OAuth2Token -> ShowS

show :: OAuth2Token -> String

showList :: [OAuth2Token] -> ShowS

ToJSON OAuth2Token

Defined in Web.Pixiv.Auth

Methods

toJSON :: OAuth2Token -> Value

toEncoding :: OAuth2Token -> Encoding

toJSONList :: [OAuth2Token] -> Value

toEncodingList :: [OAuth2Token] -> Encoding

FromJSON OAuth2Token

Defined in Web.Pixiv.Auth

Methods

parseJSON :: Value -> Parser OAuth2Token

parseJSONList :: Value -> Parser [OAuth2Token]

data OAuth2Error

Failed result.

Constructors

OAuth2Error

Fields

• oa_error :: Errors
• oa_message :: Text

Instances

Eq OAuth2Error

Defined in Web.Pixiv.Auth

Methods

(==) :: OAuth2Error -> OAuth2Error -> Bool

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

Read OAuth2Error

Defined in Web.Pixiv.Auth

Methods

readsPrec :: Int -> ReadS OAuth2Error

readList :: ReadS [OAuth2Error]

readPrec :: ReadPrec OAuth2Error

readListPrec :: ReadPrec [OAuth2Error]

Show OAuth2Error

Defined in Web.Pixiv.Auth

Methods

showsPrec :: Int -> OAuth2Error -> ShowS

show :: OAuth2Error -> String

showList :: [OAuth2Error] -> ShowS

FromJSON OAuth2Error

Defined in Web.Pixiv.Auth

Methods

parseJSON :: Value -> Parser OAuth2Error

parseJSONList :: Value -> Parser [OAuth2Error]

Exception OAuth2Error

Defined in Web.Pixiv.Auth

Methods

toException :: OAuth2Error -> SomeException

fromException :: SomeException -> Maybe OAuth2Error

displayException :: OAuth2Error -> String

data OAuth2Result

Authentication result.

Constructors

AuthSuccess OAuth2Token

AuthFailure OAuth2Error

Instances

Eq OAuth2Result

Defined in Web.Pixiv.Auth

Methods

(==) :: OAuth2Result -> OAuth2Result -> Bool

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

Show OAuth2Result

Defined in Web.Pixiv.Auth

Methods

showsPrec :: Int -> OAuth2Result -> ShowS

show :: OAuth2Result -> String

showList :: [OAuth2Result] -> ShowS

FromJSON OAuth2Result

Defined in Web.Pixiv.Auth

Methods

parseJSON :: Value -> Parser OAuth2Result

parseJSONList :: Value -> Parser [OAuth2Result]

data Errors

Authentication failure reasons.

Constructors

InvalidRequest

InvalidClient

InvalidGrant

UnauthorizedClient

UnsupportedGrantType

InvalidScope

Instances

Enum Errors

Defined in Web.Pixiv.Auth

Methods

succ :: Errors -> Errors

pred :: Errors -> Errors

toEnum :: Int -> Errors

fromEnum :: Errors -> Int

enumFrom :: Errors -> [Errors]

enumFromThen :: Errors -> Errors -> [Errors]

enumFromTo :: Errors -> Errors -> [Errors]

enumFromThenTo :: Errors -> Errors -> Errors -> [Errors]

Eq Errors

Defined in Web.Pixiv.Auth

Methods

(==) :: Errors -> Errors -> Bool

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

Ord Errors

Defined in Web.Pixiv.Auth

Methods

compare :: Errors -> Errors -> Ordering

(<) :: Errors -> Errors -> Bool

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

(>) :: Errors -> Errors -> Bool

(>=) :: Errors -> Errors -> Bool

max :: Errors -> Errors -> Errors

min :: Errors -> Errors -> Errors

Read Errors

Defined in Web.Pixiv.Auth

Methods

readsPrec :: Int -> ReadS Errors

readList :: ReadS [Errors]

readPrec :: ReadPrec Errors

readListPrec :: ReadPrec [Errors]

Show Errors

Defined in Web.Pixiv.Auth

Methods

showsPrec :: Int -> Errors -> ShowS

show :: Errors -> String

showList :: [Errors] -> ShowS

ToJSON Errors

Defined in Web.Pixiv.Auth

Methods

toJSON :: Errors -> Value

toEncoding :: Errors -> Encoding

toJSONList :: [Errors] -> Value

toEncodingList :: [Errors] -> Encoding

FromJSON Errors

Defined in Web.Pixiv.Auth

Methods

parseJSON :: Value -> Parser Errors

parseJSONList :: Value -> Parser [Errors]

auth :: Manager -> Credential -> IO OAuth2Result

Given a credential, performs a authentication request.

auth' :: Manager -> Credential -> IO OAuth2Token

Like auth, but immediately throws OAuth2Error if auth failed.