Network.Pushover.Reader

This module exposes types intended to make it easy to incorporate Pushover request functionality within an existing application.

The PushoverReader class is designed to make it easy to extend an existing reader environment to include the information required by Pushover in the making of requests.

PushoverKeys is a simple type available for immediate use should a developer not yet have a reader environment and wants quickly to use Pushover.

Documentation

class PushoverReader r where

The PushoverReader class is intended to make it straightforward to incorporate the making of Pushover requests within an existing monad stack.

This class is intended to make it easy to add an API token and user key to an existing reader monad environment.

Minimal complete definition

apiToken, userKey

Methods

apiToken :: r -> APIToken

userKey :: r -> UserKey

Instances

PushoverReader PushoverKeys

Methods

apiToken :: PushoverKeys -> APIToken

userKey :: PushoverKeys -> UserKey

data PushoverKeys

A basic type for use in storing the pair of keys required for making a request.

Constructors

PushoverKeys

Fields

• _apiToken :: APIToken
• _userKey :: UserKey

Instances

Show PushoverKeys

Methods

showsPrec :: Int -> PushoverKeys -> ShowS

show :: PushoverKeys -> String

showList :: [PushoverKeys] -> ShowS

PushoverReader PushoverKeys

Methods

apiToken :: PushoverKeys -> APIToken

userKey :: PushoverKeys -> UserKey

type UnvalidatedAPIToken = Text

An unvalidated API token.

type UnvalidatedUserKey = Text

An unvalidated user key.

createKeys :: (Error e, MonadError e m) => UnvalidatedAPIToken -> UnvalidatedUserKey -> m PushoverKeys

Construct a PushoverKeys value.

This attempts to create valid tokens/keys from a pair of unvalidated tokens/keys, returning the result wrapped within a MonadError.