Enum PushType
- All Implemented Interfaces:
Serializable
,Comparable<PushType>
,java.lang.constant.Constable
public enum PushType extends Enum<PushType>
- Since:
- 0.13.9
- See Also:
- Sending Notification Requests to APNs
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description ALERT
Indicates that a push notification is expected to display an alert, play a sound, or badges the receiving apps' icon.BACKGROUND
Indicates that a push notification is not expected to interact with the user on the receiving device.COMPLICATION
Indicates that a push notification is intended to provide an update for a watchOS app complication.FILEPROVIDER
Indicates that a push notification is intended to update a File Provider extension.MDM
Indicates that a push notification is intended to cause the receiving device to contact its mobile device management (MDM) server.VOIP
Indicates that a push notification is expected to activate the client for handling VoIP flow. -
Method Summary
Modifier and Type Method Description static PushType
getFromHeaderValue(CharSequence headerValue)
String
getHeaderValue()
static PushType
valueOf(String name)
Returns the enum constant of this type with the specified name.static PushType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
ALERT
Indicates that a push notification is expected to display an alert, play a sound, or badges the receiving apps' icon. According to Apple's documentation:
Use the
alert
push type for notifications that trigger a user interaction—for example, an alert, badge, or sound. If you set this push type, theapns-topic
header field must use your app’s bundle ID as the topic… Thealert
push type is required on watchOS 6 and later. It is recommended on macOS, iOS, tvOS, and iPadOS.- Since:
- 0.13.9
-
BACKGROUND
Indicates that a push notification is not expected to interact with the user on the receiving device. According to Apple's documentation:
Use the background push type for notifications that deliver content in the background, and don’t trigger any user interactions. If you set this push type, the apns-topic header field must use your app’s bundle ID as the topic. The background push type is required on watchOS 6 and later. It is recommended on macOS, iOS, tvOS, and iPadOS.
- Since:
- 0.13.9
-
VOIP
Indicates that a push notification is expected to activate the client for handling VoIP flow. According to Apple's documentation:
Use the
voip
push type for notifications that provide information about an incoming Voice-over-IP (VoIP) call… If you set this push type, theapns-topic
header field must use your app’s bundle ID with.voip
appended to the end. If you’re using certificate-based authentication, you must also register the certificate for VoIP services. The topic is then part of the 1.2.840.113635.100.6.3.4 or 1.2.840.113635.100.6.3.6 extension. Thevoip
push type is not available on watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS.- Since:
- 0.13.10
-
COMPLICATION
Indicates that a push notification is intended to provide an update for a watchOS app complication. According to Apple's documentation:
Use the
complication
push type for notifications that contain update information for a watchOS app’s complications… If you set this push type, theapns-topic
header field must use your app’s bundle ID with.complication
appended to the end. If you’re using certificate-based authentication, you must also register the certificate for WatchKit services. The topic is then part of the 1.2.840.113635.100.6.3.6 extension. Thecomplication
push type is recommended for watchOS and iOS. It is not available on macOS, tvOS, and iPadOS.- Since:
- 0.13.10
-
FILEPROVIDER
Indicates that a push notification is intended to update a File Provider extension. According to Apple's documentation:
Use the
fileprovider
push type to signal changes to a File Provider extension. If you set this push type, the apns-topic header field must use your app’s bundle ID with.pushkit.fileprovider
appended to the end… The fileprovider push type is not available on watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS.- Since:
- 0.13.10
-
MDM
Indicates that a push notification is intended to cause the receiving device to contact its mobile device management (MDM) server. According to Apple's documentation:
Use the
mdm
push type for notifications that tell managed devices to contact the MDM server. If you set this push type, you must use the topic from the UID attribute in the subject of your MDM push certificate… The mdm push type is not available on watchOS. It is recommended on macOS, iOS, tvOS, and iPadOS.- Since:
- 0.13.10
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getHeaderValue
-
getFromHeaderValue
-