Web.WebPush

Functions

sendPushNotification :: (MonadIO m, ToJSON msg, MonadRandom m) => Manager -> VapidConfig -> PushNotification msg -> Subscription -> m (Either PushNotificationError PushNotificationCreated)

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

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

sendPushNotifications :: (MonadIO m, ToJSON msg, MonadRandom m) => Manager -> VapidConfig -> PushNotification msg -> [Subscription] -> m [(Subscription, Either PushNotificationError PushNotificationCreated)]

Send a push notification to multiple subscribers similar to sendPushNotification but shares VAPID keys across multiple requests

Types

data Subscription

Subscription information for a push notification

Constructors

Subscription

Fields

• subscriptionEndpoint :: URI

  Endpoint URI to remote push service

• subscriptionP256dh :: PushP256dh

  Public key of the client

• subscriptionAuth :: PushAuth

  Authentication secret of the client

Instances

Show Subscription

Defined in Web.WebPush

Methods

showsPrec :: Int -> Subscription -> ShowS

show :: Subscription -> String

showList :: [Subscription] -> ShowS

Eq Subscription

Defined in Web.WebPush

Methods

(==) :: Subscription -> Subscription -> Bool

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

Ord Subscription

Defined in Web.WebPush

Methods

compare :: Subscription -> Subscription -> Ordering

(<) :: Subscription -> Subscription -> Bool

(<=) :: Subscription -> Subscription -> Bool

(>) :: Subscription -> Subscription -> Bool

(>=) :: Subscription -> Subscription -> Bool

max :: Subscription -> Subscription -> Subscription

min :: Subscription -> Subscription -> Subscription

data VapidConfig

Configuration for VAPID server identification

Constructors

VapidConfig

Fields

• vapidConfigContact :: Text

  Contact information for the application server, either a `mailto:` URI or an HTTPS URL

• vapidConfigKeys :: VAPIDKeys

  Keypair used to sign the VAPID identification

data PushNotification msg

Web push notification expiration and message to send

Constructors

PushNotification

Fields

• pnExpireInSeconds :: Int

  Expiration time in seconds

• pnMessage :: msg

  Message to send

Instances

Show msg => Show (PushNotification msg)

Defined in Web.WebPush

Methods

showsPrec :: Int -> PushNotification msg -> ShowS

show :: PushNotification msg -> String

showList :: [PushNotification msg] -> ShowS

Eq msg => Eq (PushNotification msg)

Defined in Web.WebPush

Methods

(==) :: PushNotification msg -> PushNotification msg -> Bool

(/=) :: PushNotification msg -> PushNotification msg -> Bool

Ord msg => Ord (PushNotification msg)

Defined in Web.WebPush

Methods

compare :: PushNotification msg -> PushNotification msg -> Ordering

(<) :: PushNotification msg -> PushNotification msg -> Bool

(<=) :: PushNotification msg -> PushNotification msg -> Bool

(>) :: PushNotification msg -> PushNotification msg -> Bool

(>=) :: PushNotification msg -> PushNotification msg -> Bool

max :: PushNotification msg -> PushNotification msg -> PushNotification msg

min :: PushNotification msg -> PushNotification msg -> PushNotification msg

data PushNotificationCreated

Result of a successful push notification request

Constructors

PushNotificationCreated

Fields

• pushNotificationCreatedTTL :: Maybe Int

  Optional TTL of the notification

Instances

Show PushNotificationCreated

Defined in Web.WebPush

Methods

showsPrec :: Int -> PushNotificationCreated -> ShowS

show :: PushNotificationCreated -> String

showList :: [PushNotificationCreated] -> ShowS

Eq PushNotificationCreated

Defined in Web.WebPush

Methods

(==) :: PushNotificationCreated -> PushNotificationCreated -> Bool

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

Ord PushNotificationCreated

Defined in Web.WebPush

Methods

compare :: PushNotificationCreated -> PushNotificationCreated -> Ordering

(<) :: PushNotificationCreated -> PushNotificationCreated -> Bool

(<=) :: PushNotificationCreated -> PushNotificationCreated -> Bool

(>) :: PushNotificationCreated -> PushNotificationCreated -> Bool

(>=) :: PushNotificationCreated -> PushNotificationCreated -> Bool

max :: PushNotificationCreated -> PushNotificationCreated -> PushNotificationCreated

min :: PushNotificationCreated -> PushNotificationCreated -> PushNotificationCreated

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 HttpException

Endpoint URL could not be parsed

PushNotificationBadHost URI

PushEncryptError EncryptError

ApplicationKeyEncodeError String

Application server key encoding failed

RecepientEndpointNotFound

The endpoint is no longer recognized by the push service

PushRequestFailed SomeException

Push request failed

PushRequestNotCreated (Response ByteString)

Push request failed with non-201 status code

Instances

Exception PushNotificationError

Defined in Web.WebPush

Methods

toException :: PushNotificationError -> SomeException

fromException :: SomeException -> Maybe PushNotificationError

displayException :: PushNotificationError -> String

Show PushNotificationError

Defined in Web.WebPush

Methods

showsPrec :: Int -> PushNotificationError -> ShowS

show :: PushNotificationError -> String

showList :: [PushNotificationError] -> ShowS

type PushP256dh = Text

type PushAuth = Text

module Web.WebPush.Keys