Web.WebPush

Functions

generateVAPIDKeys :: MonadRandom m => m VAPIDKeysMinDetails

Generate the 3 integers minimally representing a unique pair of public and private keys.

Store them in configuration and use them across multiple push notification requests.

readVAPIDKeys :: VAPIDKeysMinDetails -> VAPIDKeys

Read VAPID key pair from the 3 integers minimally representing a unique key pair.

vapidPublicKeyBytes :: VAPIDKeys -> [Word8]

Pass the VAPID public key bytes to browser when subscribing to push notifications. Generate application server key using applicationServerKey = new Uint8Array(vapidPublicKeyBytes) in Javascript.

sendPushNotification :: MonadIO m => VAPIDKeys -> Manager -> PushNotificationDetails -> m (Either PushNotificationError ())

Send a Push Message. The message sent is Base64 URL encoded. Decode the message in Service Worker notification handler in browser before trying to read the JSON.

Types

type VAPIDKeys = KeyPair

data VAPIDKeysMinDetails

3 integers minimally representing a unique VAPID key pair.

Constructors

VAPIDKeysMinDetails

Fields

• privateNumber :: Integer
• publicCoordX :: Integer
• publicCoordY :: Integer

data PushNotificationDetails

Web push subscription and message details.

Get subscription details from front end using subscription.endpoint, subscription.toJSON().keys.p256dh and subscription.toJSON().keys.auth. Save subscription details to send messages to the endpoint in future.

Constructors

PushNotificationDetails

Fields

• endpoint :: Text
• p256dh :: Text
• auth :: Text
• senderEmail :: Text
• expireInHours :: Int64
• message :: PushNotificationMessage

data PushNotificationMessage

Constructors

PushNotificationMessage

Fields

• title :: Text
• body :: Text
• icon :: Text
• url :: Text
• tag :: Text

Instances

ToJSON PushNotificationMessage

Methods

toJSON :: PushNotificationMessage -> Value

toEncoding :: PushNotificationMessage -> Encoding

toJSONList :: [PushNotificationMessage] -> Value

toEncodingList :: [PushNotificationMessage] -> Encoding

data PushNotificationError

RecepientEndpointNotFound comes up when the endpoint is no longer recognized by the push service. This may happen if the user has cancelled the push subscription, and hence deleted the endpoint. You may want to delete the endpoint from database in this case.

Constructors

EndpointParseFailed SomeException

JWTGenerationFailed Error

MessageEncryptionFailed CryptoError

RecepientEndpointNotFound

PushRequestFailed SomeException