| Copyright | (C) 2016 Ismail Mustafa |
|---|---|
| License | BSD-style (see the file LICENSE) |
| Maintainer | Ismail Mustafa <ismailmustafa@rocketmail.com |
| Stability | provisional |
| Portability | OverloadedStrings |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Handwriting
Description
API Client for the handwriting.io API.
- getHandwriting :: Credentials -> String -> IO Handwriting
- getHandwritings :: Credentials -> IO [Handwriting]
- renderImage :: Credentials -> ImageParams -> String -> IO ByteString
- type Color = (Word8, Word8, Word8)
- data Credentials = Credentials {
- keyToken :: String
- secretToken :: String
- defaultImageParams :: ImageParams
- data Format
- data Handwriting = Handwriting {}
- data ImageParams = ImageParams {}
- data PDFUnits
- data RandomSeed
Endpoints
getHandwriting :: Credentials -> String -> IO Handwriting #
Get a single handwriting by id.
import Network.Handwriting
creds :: Credentials
creds = Credentials "key" "secret"
main :: IO ()
main = do
handwritings <- getHandwritings creds "31SF81NG00ES"getHandwritings :: Credentials -> IO [Handwriting] #
Get a list of all Handwritings.
import Network.Handwriting
creds :: Credentials
creds = Credentials "key" "secret"
main :: IO ()
main = do
handwritings <- getHandwritings credsrenderImage :: Credentials -> ImageParams -> String -> IO ByteString #
Get a handwriting image as either a PDF or PNG.
import Network.Handwriting
creds :: Credentials
creds = Credentials "key" "secret"
main :: IO ()
main = do
let params = defaultImageParams {format = PDF}
imageByteString <- renderImage creds params "Hello World!"Types, DataTypes, and Utilities
data Credentials #
Credentials that take and key and secret token.
Constructors
| Credentials | |
Fields
| |
Instances
defaultImageParams :: ImageParams #
Default image parameters provided for convenience.
Format determines rendered image format in either png or pdf.
data Handwriting #
Handwriting data type that contains all the information about a specific handwriting style.
Constructors
| Handwriting | |
Fields
| |
Instances
| Show Handwriting # | Pretty print the handwriting data type. |
| Generic Handwriting # | |
| ToJSON Handwriting # | |
| FromJSON Handwriting # | Handwriting JSON instance. |
| type Rep Handwriting # | |
data ImageParams #
Optional image parameters that dictate different properties of the rendered image.
Constructors
| ImageParams | |
Instances
PDFUnits is used to specify measurements when rendering a PDF.
data RandomSeed #
RandomSeed is used to specify if every rendered image called with the same parameters should render differently or the same each time.
Constructors
| Randomize | |
| Repeatable |
Instances