Uses of Class
com.eatthepath.pushy.apns.util.ApnsPayloadBuilder
Package | Description |
---|---|
com.eatthepath.pushy.apns.util |
Contains classes for working with APNs tokens and payloads.
|
-
Uses of ApnsPayloadBuilder in com.eatthepath.pushy.apns.util
Subclasses of ApnsPayloadBuilder in com.eatthepath.pushy.apns.util Modifier and Type Class Description class
SimpleApnsPayloadBuilder
A simple APNs payload builder that serializes payloads using aJsonSerializer
.Methods in com.eatthepath.pushy.apns.util that return ApnsPayloadBuilder Modifier and Type Method Description ApnsPayloadBuilder
ApnsPayloadBuilder. addCustomProperty(String key, Object value)
Adds a custom property to the payload.ApnsPayloadBuilder
ApnsPayloadBuilder. setActionButtonLabel(String action)
Sets the literal text of the action button to be shown for the push notification for Safari push notifications only.ApnsPayloadBuilder
ApnsPayloadBuilder. setAlertBody(String alertBody)
Sets the literal text of the alert message to be shown for the push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setAlertSubtitle(String alertSubtitle)
Sets a subtitle for the notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setAlertTitle(String alertTitle)
Sets a short description of the notification purpose.ApnsPayloadBuilder
ApnsPayloadBuilder. setBadgeNumber(Integer badgeNumber)
Sets the number to display as the badge of the icon of the application that receives the push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setCategoryName(String categoryName)
Sets the name of the action category name for interactive remote notifications.ApnsPayloadBuilder
ApnsPayloadBuilder. setContentAvailable(boolean contentAvailable)
Sets whether the payload under construction should contain a flag that indicates that new content is available to be downloaded in the background by the receiving app.ApnsPayloadBuilder
ApnsPayloadBuilder. setLaunchImageFileName(String launchImageFilename)
Sets the image to be shown when the receiving app launches in response to this push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setLocalizedActionButtonKey(String localizedActionButtonKey)
Sets the key of a string in the receiving app's localized string list to be used as the label of the "action" button if the push notification is displayed as an alert.ApnsPayloadBuilder
ApnsPayloadBuilder. setLocalizedAlertMessage(String localizedAlertKey, String... alertArguments)
Sets the key of a message in the receiving app's localized string list to be shown for the push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setLocalizedAlertSubtitle(String localizedAlertSubtitleKey, String... alertSubtitleArguments)
Sets the key of the subtitle string in the receiving app's localized string list to be shown for the push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setLocalizedAlertTitle(String localizedAlertTitleKey, String... alertTitleArguments)
Sets the key of the title string in the receiving app's localized string list to be shown for the push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setMutableContent(boolean mutableContent)
Sets whether the receiving device may modify the content of the push notification before displaying it.ApnsPayloadBuilder
ApnsPayloadBuilder. setPreferStringRepresentationForAlerts(boolean preferStringRepresentationForAlerts)
/** Sets whether this payload builder will attempt to represent alerts as strings when possible.ApnsPayloadBuilder
ApnsPayloadBuilder. setShowActionButton(boolean showActionButton)
Sets whether an "action" button should be shown if the push notification is displayed as an alert.ApnsPayloadBuilder
ApnsPayloadBuilder. setSound(String soundFileName)
Sets the name of the sound file to play when the push notification is received.ApnsPayloadBuilder
ApnsPayloadBuilder. setSound(String soundFileName, boolean isCriticalAlert, double soundVolume)
Sets the name of the sound file to play when the push notification is received along with its volume and whether it should be presented as a critical alert.ApnsPayloadBuilder
ApnsPayloadBuilder. setSoundFileName(String soundFileName)
Deprecated.As of v0.13.3, please usesetSound(String)
instead.ApnsPayloadBuilder
ApnsPayloadBuilder. setSummaryArgument(String summaryArgument)
Sets the summary argument for this notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setSummaryArgumentCount(Integer summaryArgumentCount)
Sets the summary argument count for this notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setTargetContentId(String targetContentId)
Sets the identifier of the window to be brought forward by this notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setThreadId(String threadId)
Sets the thread ID for this notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setUrlArguments(String... arguments)
Sets the list of arguments to populate placeholders in theurlFormatString
associated with a Safari push notification.ApnsPayloadBuilder
ApnsPayloadBuilder. setUrlArguments(List<String> arguments)
Sets the list of arguments to populate placeholders in theurlFormatString
associated with a Safari push notification.