Uses of Class
com.eatthepath.pushy.apns.util.ApnsPayloadBuilder
Package
Description
Contains classes for working with APNs tokens and payloads.
-
Uses of ApnsPayloadBuilder in com.eatthepath.pushy.apns.util
Modifier and TypeClassDescriptionclass
A simple APNs payload builder that serializes payloads using aJsonSerializer
.Modifier and TypeMethodDescriptionApnsPayloadBuilder.addCustomProperty
(String key, Object value) Adds a custom property to the payload.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.setAlertBody
(String alertBody) Sets the literal text of the alert message to be shown for the push notification.ApnsPayloadBuilder.setAlertSubtitle
(String alertSubtitle) Sets a subtitle for the notification.ApnsPayloadBuilder.setAlertTitle
(String alertTitle) Sets a short description of the notification purpose.ApnsPayloadBuilder.setAttributes
(Map<String, Object> attributes) Sets the values of iOSContentState
attributes when starting a Live Activity.ApnsPayloadBuilder.setAttributesType
(String attributesType) Sets the type of iOSActivityAttributes
used for a Live Activity.ApnsPayloadBuilder.setBadgeNumber
(Integer badgeNumber) Sets the number to display as the badge of the icon of the application that receives the push notification.ApnsPayloadBuilder.setCategoryName
(String categoryName) Sets the name of the action category name for interactive remote notifications.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.setContentState
(Map<String, Object> contentState) Sets the content state object inside content-state payload for Live Activities.ApnsPayloadBuilder.setDismissalDate
(Instant dismissalDate) Sets a dismissal timestamp for Live Activity notifications.ApnsPayloadBuilder.setEvent
(LiveActivityEvent event) Sets whether the notification payload will be used for updating the Live Activity or for ending it.ApnsPayloadBuilder.setInterruptionLevel
(InterruptionLevel interruptionLevel) Sets the interruption level for this notification.ApnsPayloadBuilder.setLaunchImageFileName
(String launchImageFilename) Sets the image to be shown when the receiving app launches in response to this push notification.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.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.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.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.setMutableContent
(boolean mutableContent) Sets whether the receiving device may modify the content of the push notification before displaying it.ApnsPayloadBuilder.setPreferStringRepresentationForAlerts
(boolean preferStringRepresentationForAlerts) /** Sets whether this payload builder will attempt to represent alerts as strings when possible.ApnsPayloadBuilder.setRelevanceScore
(Double relevanceScore) Sets the relevance score for this notification.ApnsPayloadBuilder.setShowActionButton
(boolean showActionButton) Sets whether an "action" button should be shown if the push notification is displayed as an alert.Sets the name of the sound file to play when the push notification is received.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.setSoundFileName
(String soundFileName) Deprecated.ApnsPayloadBuilder.setStaleDate
(Instant staleDate) Sets a "stale" timestamp for Live Activity notification payloads.ApnsPayloadBuilder.setSummaryArgument
(String summaryArgument) Sets the summary argument for this notification.ApnsPayloadBuilder.setSummaryArgumentCount
(Integer summaryArgumentCount) Sets the summary argument count for this notification.ApnsPayloadBuilder.setTargetContentId
(String targetContentId) Sets the identifier of the window to be brought forward by this notification.ApnsPayloadBuilder.setThreadId
(String threadId) Sets the thread ID for this notification.ApnsPayloadBuilder.setTimestamp
(Instant timestamp) Sets the Live Activity timestamp for the push notification payload.ApnsPayloadBuilder.setUrlArguments
(String... arguments) Sets the list of arguments to populate placeholders in theurlFormatString
associated with a Safari push notification.ApnsPayloadBuilder.setUrlArguments
(List<String> arguments) Sets the list of arguments to populate placeholders in theurlFormatString
associated with a Safari push notification.
setSound(String)
instead.