Safe Haskell	None
Language	Haskell2010

Network.Pushover.Request

Contents

Constructing a request
Other request parameters
HTTP request helper

Synopsis

Constructing a request

data Request Source #

Contains the contents of a Pushover notification request. This follows the API specification at https://pushover.net/api.

Constructors

Request

Fields

requestToken :: APIToken
The API token provided by your Pushover app's dashboard at https://pushover.net/apps.
requestUserKey :: UserKey
The user key of the user receiving this notification, found in the Pushover dashboard at https://pushover.net/dashboard.
requestMessage :: Message
The notification message to push to the user.
devices :: [Text]
An optional list of devices to which to send the notification. If empty, it will be sent to all of the user's devices.
title :: Maybe Text
An optional title for the message.
url :: Maybe URL
An optional URL for inclusion with the message.
priority :: Maybe Priority
The priority of this message. This affects way in which the notification is presented to the receiving user. See Priority for more information.
timestamp :: Maybe UTCTime
An optional timestamp for the notification. If no timestamp is provided, the time the request is received by the Pushover API is used.
notificationSound :: Maybe NotificationSound
The notification sound to use. The default is Pushover, with None provided for a silent notification.

Instances

Eq Request Source #
Methods (==) :: Request -> Request -> Bool # (/=) :: Request -> Request -> Bool #
Show Request Source #
Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #

defaultRequest :: APIToken -> UserKey -> Message -> Request Source #

Construct a default request value.

As a request requires, at a minimum, an API token, a user key and a message, this function requires each of these values as an argument. Other fields can then be initialised using the regular Haskell record syntax.

Other request parameters

data URL Source #

A URL for sending within a notification request.

A Pushover URL is optional within a request; if present, it may optionally contain a title to display instead of the URL itself.

Constructors

URL
Fields urlPath :: Text urlTitle :: Maybe Text

Instances

Eq URL Source #
Methods (==) :: URL -> URL -> Bool # (/=) :: URL -> URL -> Bool #
Show URL Source #
Methods showsPrec :: Int -> URL -> ShowS # show :: URL -> String # showList :: [URL] -> ShowS #

data Priority Source #

Describes the priority of a particular message.

The different priority settings affect the way in which a notification is presented to the user. See https://pushover.net/api#priority for specific details.

Constructors

Lowest
Low
Normal
High
Emergency

Instances

Eq Priority Source #
Methods (==) :: Priority -> Priority -> Bool # (/=) :: Priority -> Priority -> Bool #
Show Priority Source #
Methods showsPrec :: Int -> Priority -> ShowS # show :: Priority -> String # showList :: [Priority] -> ShowS #

data NotificationSound Source #

Describes the notification sound for a notification.

Instances

Eq NotificationSound Source #
Methods (==) :: NotificationSound -> NotificationSound -> Bool # (/=) :: NotificationSound -> NotificationSound -> Bool #
Show NotificationSound Source #
Methods showsPrec :: Int -> NotificationSound -> ShowS # show :: NotificationSound -> String # showList :: [NotificationSound] -> ShowS #

HTTP request helper

makeHttpRequest :: Request -> IO Request Source #

Construct an HTTP request out of a Pushover request value.

This function is exposed for use by the functions in the Network.Pushover.Execute module. It is unlikely that the user will require to call it directly.

Pushover
Bike
Bugle
CashRegister
Classical
Cosmic
Falling
Gamelan
Incoming
Intermission
Magic
Mechanical
PianoBar
Siren
SpaceAlarm
TugBoat
AlienAlarm
Climb
Persistent
Echo
UpDown
None