Safe Haskell	None
Language	Haskell2010

Microsoft.Translator.API.Auth

Description

Servant types and client for the authorization API

Synopsis

Documentation

A key to your subscription to the service. Used to retrieve an AuthToken.

Constructors

Instances

Show SubscriptionKey Source #
Methods showsPrec :: Int -> SubscriptionKey -> ShowS # show :: SubscriptionKey -> String # showList :: [SubscriptionKey] -> ShowS #
IsString SubscriptionKey Source #
Methods fromString :: String -> SubscriptionKey #
ToHttpApiData SubscriptionKey Source #
Methods toUrlPiece :: SubscriptionKey -> Text # toEncodedUrlPiece :: SubscriptionKey -> Builder # toHeader :: SubscriptionKey -> ByteString # toQueryParam :: SubscriptionKey -> Text #

The JSON Web Token issued by MS Microsoft.Translator token service. Consists of wrapped text. Valid for ten minutes.

Instances

Show AuthToken Source #
Methods showsPrec :: Int -> AuthToken -> ShowS # show :: AuthToken -> String # showList :: [AuthToken] -> ShowS #
Generic AuthToken Source #
Associated Types type Rep AuthToken :: * -> * # Methods from :: AuthToken -> Rep AuthToken x # to :: Rep AuthToken x -> AuthToken #
ToHttpApiData AuthToken Source #
Methods toUrlPiece :: AuthToken -> Text # toEncodedUrlPiece :: AuthToken -> Builder # toHeader :: AuthToken -> ByteString # toQueryParam :: AuthToken -> Text #
type Rep AuthToken Source #
type Rep AuthToken = D1 * (MetaData "AuthToken" "Microsoft.Translator.API.Auth" "microsoft-translator-0.1.1-SJQ3sfTzucJoM4Lfl3DNf" True) (C1 * (MetaCons "AuthToken" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

Instances

Show TranslatorException Source #
Methods showsPrec :: Int -> TranslatorException -> ShowS # show :: TranslatorException -> String # showList :: [TranslatorException] -> ShowS #
Exception TranslatorException Source #
Methods toException :: TranslatorException -> SomeException # fromException :: SomeException -> Maybe TranslatorException # displayException :: TranslatorException -> String #

Retrieve a token from the API. It will be valid for 10 minutes.