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

Contents

Endpoints
Types, DataTypes, and Utilities

Description

API Client for the handwriting.io API.

Synopsis

Endpoints

getHandwriting :: Credentials -> String -> IO Handwriting Source

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] Source

Get a list of all Handwritings.

import Network.Handwriting
creds :: Credentials
creds = Credentials "key" "secret"

main :: IO ()
main = do
    handwritings <- getHandwritings creds

renderImage :: Credentials -> ImageParams -> String -> IO ByteString Source

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

type Color = (Word8, Word8, Word8) Source

Color type representing (R,G,B).

data Credentials Source

Credentials that take and key and secret token.

Constructors

Credentials
Fields keyToken :: String secretToken :: String

Instances

Show Credentials Source

defaultImageParams :: ImageParams Source

Default image parameters provided for convenience.

data Format Source

Format determines rendered image format in either png or pdf.

Constructors

PNG
PDF

Instances

Show Format Source

data Handwriting Source

Handwriting data type that contains all the information about a specific handwriting style.

Constructors

Handwriting
Fields handwritingId :: Text title :: Text dateCreated :: Text dateModified :: Text ratingNeatness :: Double ratingCursivity :: Double ratingEmbellishment :: Double ratingCharacterWidth :: Double

Instances

Show Handwriting Source	Pretty print the handwriting data type.
Generic Handwriting Source
ToJSON Handwriting Source
FromJSON Handwriting Source	Handwriting JSON instance.
type Rep Handwriting Source

data ImageParams Source

Optional image parameters that dictate different properties of the rendered image.

Constructors

ImageParams
Fields format :: Format width :: Maybe Double height :: Maybe Double hId :: Maybe String size :: Maybe Double color :: Maybe Color lineSpacing :: Maybe Double lineSpacingVariance :: Maybe Double wordSpacingVariance :: Maybe Double randomSeed :: RandomSeed pdfUnits :: PDFUnits

Instances

Show ImageParams Source

data PDFUnits Source

PDFUnits is used to specify measurements when rendering a PDF.

Constructors

Points
Inches

Instances

Show PDFUnits Source

data RandomSeed Source

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

Show RandomSeed Source