Package com.eatthepath.pushy.apns.util

Class SimpleApnsPayloadBuilder

java.lang.Object

com.eatthepath.pushy.apns.util.ApnsPayloadBuilder

com.eatthepath.pushy.apns.util.SimpleApnsPayloadBuilder

public class SimpleApnsPayloadBuilder
extends ApnsPayloadBuilder

A simple APNs payload builder that serializes payloads using a JsonSerializer. Please see the documentation for JsonSerializer for details about how this payload builder serializes custom properties.

Since:

0.14.0

Author:

Jon Chambers

Field Summary

Fields inherited from class com.eatthepath.pushy.apns.util.ApnsPayloadBuilder

DEFAULT_SOUND_FILENAME, EMPTY_STRING_ARRAY

Constructor Summary

Constructors

Constructor	Description
SimpleApnsPayloadBuilder()

Method Summary

Modifier and Type	Method	Description
String	build()	Returns a JSON representation of the push notification payload under construction.
String	buildMdmPayload(String pushMagicValue)	Returns a JSON representation of a Mobile Device Management "wake up" payload.

Methods inherited from class com.eatthepath.pushy.apns.util.ApnsPayloadBuilder

addCustomProperty, setActionButtonLabel, setAlertBody, setAlertSubtitle, setAlertTitle, setAttributes, setAttributesType, setBadgeNumber, setCategoryName, setContentAvailable, setContentState, setDismissalDate, setEvent, setInterruptionLevel, setLaunchImageFileName, setLocalizedActionButtonKey, setLocalizedAlertMessage, setLocalizedAlertSubtitle, setLocalizedAlertTitle, setMutableContent, setPreferStringRepresentationForAlerts, setRelevanceScore, setShowActionButton, setSound, setSound, setSoundFileName, setStaleDate, setSummaryArgument, setSummaryArgumentCount, setTargetContentId, setThreadId, setTimestamp, setUrlArguments, setUrlArguments

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimpleApnsPayloadBuilder

public SimpleApnsPayloadBuilder()

Method Details

build

public String build()

Description copied from class: ApnsPayloadBuilder

Returns a JSON representation of the push notification payload under construction.

Specified by:

build in class ApnsPayloadBuilder

Returns:

a JSON representation of the payload under construction

See Also:

• ApnsPayloadBuilder.buildPayloadMap()

buildMdmPayload

public String buildMdmPayload(String pushMagicValue)

Description copied from class: ApnsPayloadBuilder

Returns a JSON representation of a Mobile Device Management "wake up" payload.

Specified by:

buildMdmPayload in class ApnsPayloadBuilder

Parameters:

pushMagicValue - the "push magic" string that the device sends to the MDM server in a TokenUpdate message

Returns:

a JSON representation of an MDM "wake up" notification payload

See Also:

• Mobile Device Management (MDM) Protocol
• ApnsPayloadBuilder.buildMdmPayloadMap(String)