Network.PushNotify.APN

Send push notifications using Apple's HTTP2 APN API

Documentation

newSession

Arguments

:: FilePath

Path to the client certificate key

-> FilePath

Path to the client certificate

-> FilePath

Path to the CA

-> Bool

True if the apn development servers should be used, False to use the production servers

-> Int

How many messages will be sent in parallel? This corresponds to the number of http2 streams open in parallel; 100 seems to be a default value.

-> ByteString

Topic (bundle name of the app)

-> IO ApnSession

The newly created session

Start a new session for sending APN messages. A session consists of a connection pool of connections to the APN servers, while each connection has a pool of workers that create HTTP2 streams to send individual push notifications.

newMessage

Arguments

:: JsonApsMessage

The standard message to include

-> JsonAps

The resulting APN message

Prepare a new apn message consisting of a standard message without a custom payload

newMessageWithCustomPayload

Arguments

:: JsonApsMessage

The message

-> Text

The custom payload

-> JsonAps

The resulting APN message

Prepare a new apn message consisting of a standard message and a custom payload

hexEncodedToken

Arguments

:: Text

The base16 (hex) encoded unique identifier for a device (APN token)

-> ApnToken

The resulting token

Create a token from a hex encoded text

rawToken

Arguments

:: ByteString

The bytestring that uniquely identifies a device (APN token)

-> ApnToken

The resulting token

Create a token from a raw bytestring

sendMessage

Arguments

:: ApnSession

Session to use

-> ApnToken

Device to send the message to

-> JsonAps

The message to send

-> IO ApnMessageResult

The response from the APN server

Send a push notification message.

sendSilentMessage

Arguments

:: ApnSession

Session to use

-> ApnToken

Device to send the message to

-> IO ApnMessageResult

The response from the APN server

Send a silent push notification

sendRawMessage

Arguments

:: ApnSession

Session to use

-> ApnToken

Device to send the message to

-> ByteString

The message to send

-> IO ApnMessageResult

The response from the APN server

Send a raw payload as a push notification message (advanced)

alertMessage

Arguments

:: Text

The title of the message

-> Text

The body of the message

-> JsonApsMessage

The modified message

Create a new APN message with an alert part

emptyMessage :: JsonApsMessage

Create an empty apn message

setAlertMessage

Arguments

:: Text

The title of the message

-> Text

The body of the message

-> JsonApsMessage

The message to alter

-> JsonApsMessage

The modified message

Set the alert part of an APN message

setBadge

Arguments

:: Int

The badge number to set. The badge number is displayed next to your app's icon. Set to 0 to remove the badge number.

-> JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Set the badge part of an APN message

setCategory

Arguments

:: Text

The category to set

-> JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Set the category part of an APN message

setSound

Arguments

:: Text

The sound to use (either "default" or something in the application's bundle)

-> JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Set a sound for an APN message

clearAlertMessage

Arguments

:: JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Remove the alert part of an APN message

clearBadge

Arguments

:: JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Clear the badge part of an APN message

clearCategory

Arguments

:: JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Clear the category part of an APN message

clearSound

Arguments

:: JsonApsMessage

The message to modify

-> JsonApsMessage

The modified message

Clear the sound for an APN message

closeSession :: ApnSession -> IO ()

Manually close a session. The session must not be used anymore after it has been closed. Calling this function will close the worker thread, and all open connections to the APN service that belong to the given session. Note that sessions will be closed automatically when they are garbage collected, so it is not necessary to call this function.

isOpen :: ApnSession -> IO Bool

Check whether a session is open or has been closed by a call to closeSession

data ApnSession

A session that manages connections to Apple's push notification service

data JsonAps

A push notification message

Instances

Show JsonAps

Methods

showsPrec :: Int -> JsonAps -> ShowS

show :: JsonAps -> String

showList :: [JsonAps] -> ShowS

Generic JsonAps

Associated Types

type Rep JsonAps :: * -> *

Methods

from :: JsonAps -> Rep JsonAps x

to :: Rep JsonAps x -> JsonAps

ToJSON JsonAps

Methods

toJSON :: JsonAps -> Value

toEncoding :: JsonAps -> Encoding

toJSONList :: [JsonAps] -> Value

toEncodingList :: [JsonAps] -> Encoding

type Rep JsonAps

type Rep JsonAps = D1 * (MetaData "JsonAps" "Network.PushNotify.APN" "push-notify-apn-0.1.0.8-2RXTiHY3FXwHkxfkbNgoma" False) (C1 * (MetaCons "JsonAps" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "jaAps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * JsonApsMessage)) (S1 * (MetaSel (Just Symbol "jaAppSpecificContent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))

data JsonApsAlert

The specification of a push notification's message body

Instances

Show JsonApsAlert

Methods

showsPrec :: Int -> JsonApsAlert -> ShowS

show :: JsonApsAlert -> String

showList :: [JsonApsAlert] -> ShowS

Generic JsonApsAlert

Associated Types

type Rep JsonApsAlert :: * -> *

Methods

from :: JsonApsAlert -> Rep JsonApsAlert x

to :: Rep JsonApsAlert x -> JsonApsAlert

ToJSON JsonApsAlert

Methods

toJSON :: JsonApsAlert -> Value

toEncoding :: JsonApsAlert -> Encoding

toJSONList :: [JsonApsAlert] -> Value

toEncodingList :: [JsonApsAlert] -> Encoding

type Rep JsonApsAlert

type Rep JsonApsAlert = D1 * (MetaData "JsonApsAlert" "Network.PushNotify.APN" "push-notify-apn-0.1.0.8-2RXTiHY3FXwHkxfkbNgoma" False) (C1 * (MetaCons "JsonApsAlert" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "jaaTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "jaaBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

data JsonApsMessage

Push notification message's content

Instances

Show JsonApsMessage

Methods

showsPrec :: Int -> JsonApsMessage -> ShowS

show :: JsonApsMessage -> String

showList :: [JsonApsMessage] -> ShowS

Generic JsonApsMessage

Associated Types

type Rep JsonApsMessage :: * -> *

Methods

from :: JsonApsMessage -> Rep JsonApsMessage x

to :: Rep JsonApsMessage x -> JsonApsMessage

ToJSON JsonApsMessage

Methods

toJSON :: JsonApsMessage -> Value

toEncoding :: JsonApsMessage -> Encoding

toJSONList :: [JsonApsMessage] -> Value

toEncodingList :: [JsonApsMessage] -> Encoding

type Rep JsonApsMessage

type Rep JsonApsMessage = D1 * (MetaData "JsonApsMessage" "Network.PushNotify.APN" "push-notify-apn-0.1.0.8-2RXTiHY3FXwHkxfkbNgoma" False) (C1 * (MetaCons "JsonApsMessage" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "jamAlert") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JsonApsAlert))) (S1 * (MetaSel (Just Symbol "jamBadge") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "jamSound") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "jamCategory") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))

data ApnMessageResult

The result of a send request

Constructors

ApnMessageResultOk

ApnMessageResultFatalError

ApnMessageResultTemporaryError

ApnMessageResultTokenNoLongerValid

Instances

Enum ApnMessageResult

Methods

succ :: ApnMessageResult -> ApnMessageResult

pred :: ApnMessageResult -> ApnMessageResult

toEnum :: Int -> ApnMessageResult

fromEnum :: ApnMessageResult -> Int

enumFrom :: ApnMessageResult -> [ApnMessageResult]

enumFromThen :: ApnMessageResult -> ApnMessageResult -> [ApnMessageResult]

enumFromTo :: ApnMessageResult -> ApnMessageResult -> [ApnMessageResult]

enumFromThenTo :: ApnMessageResult -> ApnMessageResult -> ApnMessageResult -> [ApnMessageResult]

Eq ApnMessageResult

Methods

(==) :: ApnMessageResult -> ApnMessageResult -> Bool

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

Show ApnMessageResult

Methods

showsPrec :: Int -> ApnMessageResult -> ShowS

show :: ApnMessageResult -> String

showList :: [ApnMessageResult] -> ShowS

data ApnToken

An APN token used to uniquely identify a device