Web.WebPush

Functions

generateVAPIDKeys :: MonadRandom m => m VAPIDKeysMinDetails

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

Store them securely 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 browser using:

applicationServerKey = new Uint8Array( #{toJSON vapidPublicKeyBytes} )

sendPushNotification :: (MonadIO m, ToJSON msg) => VAPIDKeys -> Manager -> PushNotification msg -> m (Either PushNotificationError ())

Send a Push Message. Read the message in Service Worker notification handler in browser:

self.addEventListener('push', function(event){ console.log(event.data.json()); });

pushEndpoint :: Lens' (PushNotification msg) PushEndpoint

pushP256dh :: Lens' (PushNotification msg) PushP256dh

pushAuth :: Lens' (PushNotification msg) PushAuth

pushSenderEmail :: Lens' (PushNotification msg) Text

pushExpireInSeconds :: Lens' (PushNotification msg) Int64

pushMessage :: ToJSON msg => Lens (PushNotification a) (PushNotification msg) a msg

mkPushNotification :: PushEndpoint -> PushP256dh -> PushAuth -> PushNotification ()

Constuct a push notification.

PushEndpoint, PushP256dh and PushAuth should be obtained from push subscription in client's browser. Push message can be set through pushMessage; text and json messages are usually supported by browsers. pushSenderEmail and pushExpireInSeconds can be used to set additional details.

Types

type VAPIDKeys = KeyPair

data VAPIDKeysMinDetails

3 integers minimally representing a unique VAPID public-private key pair.

Constructors

VAPIDKeysMinDetails

Fields

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

Instances

Show VAPIDKeysMinDetails

Defined in Web.WebPush

Methods

showsPrec :: Int -> VAPIDKeysMinDetails -> ShowS

show :: VAPIDKeysMinDetails -> String

showList :: [VAPIDKeysMinDetails] -> ShowS

data PushNotification msg

Web push subscription and message details. Use mkPushNotification to construct push notification.

data PushNotificationMessage

Example payload structure for web-push. Any datatype with JSON instance can also be used instead. See mkPushNotification.

Constructors

PushNotificationMessage

Fields

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

Instances

Eq PushNotificationMessage

Defined in Web.WebPush

Methods

(==) :: PushNotificationMessage -> PushNotificationMessage -> Bool

(/=) :: PushNotificationMessage -> PushNotificationMessage -> Bool

Show PushNotificationMessage

Defined in Web.WebPush

Methods

showsPrec :: Int -> PushNotificationMessage -> ShowS

show :: PushNotificationMessage -> String

showList :: [PushNotificationMessage] -> ShowS

Generic PushNotificationMessage

Defined in Web.WebPush

Associated Types

type Rep PushNotificationMessage :: Type -> Type

Methods

from :: PushNotificationMessage -> Rep PushNotificationMessage x

to :: Rep PushNotificationMessage x -> PushNotificationMessage

ToJSON PushNotificationMessage

Defined in Web.WebPush

Methods

toJSON :: PushNotificationMessage -> Value

toEncoding :: PushNotificationMessage -> Encoding

toJSONList :: [PushNotificationMessage] -> Value

toEncodingList :: [PushNotificationMessage] -> Encoding

type Rep PushNotificationMessage

Defined in Web.WebPush

type Rep PushNotificationMessage = D1 (MetaData "PushNotificationMessage" "Web.WebPush" "web-push-0.3-A12FgFpl92wIxSsWcVlfM5" False) (C1 (MetaCons "PushNotificationMessage" PrefixI True) ((S1 (MetaSel (Just "title") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "body") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :*: (S1 (MetaSel (Just "icon") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "url") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "tag") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

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, or if EndpointParseFailed.

Constructors

EndpointParseFailed SomeException

MessageEncryptionFailed CryptoError

RecepientEndpointNotFound

PushRequestFailed SomeException

Instances

Show PushNotificationError

Defined in Web.WebPush

Methods

showsPrec :: Int -> PushNotificationError -> ShowS

show :: PushNotificationError -> String

showList :: [PushNotificationError] -> ShowS

Exception PushNotificationError

Defined in Web.WebPush

Methods

toException :: PushNotificationError -> SomeException

fromException :: SomeException -> Maybe PushNotificationError

displayException :: PushNotificationError -> String

type PushEndpoint = Text

type PushP256dh = Text

type PushAuth = Text