Package software.amazon.awssdk.services.pinpoint.model

Class APNSMessage

    • Method Detail

      • apnsPushType

        public final String apnsPushType()

        The type of push notification to send. Valid values are:

        • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.

        • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.

        • complication - For a notification that contains update information for an app’s complication timeline.

        • fileprovider - For a notification that signals changes to a File Provider extension.

        • mdm - For a notification that tells managed devices to contact the MDM server.

        • voip - For a notification that provides information about an incoming VoIP call.

        Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

        For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

        Returns:
        The type of push notification to send. Valid values are:

        • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.

        • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.

        • complication - For a notification that contains update information for an app’s complication timeline.

        • fileprovider - For a notification that signals changes to a File Provider extension.

        • mdm - For a notification that tells managed devices to contact the MDM server.

        • voip - For a notification that provides information about an incoming VoIP call.

        Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

        For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

      • action

        public final Action action()

        The action to occur if the recipient taps the push notification. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

        If the service returns an enum value that is not available in the current SDK version, action will return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

        Returns:
        The action to occur if the recipient taps the push notification. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

        See Also:
        Action

      • actionAsString

        public final String actionAsString()

        The action to occur if the recipient taps the push notification. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

        If the service returns an enum value that is not available in the current SDK version, action will return Action.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

        Returns:
        The action to occur if the recipient taps the push notification. Valid values are:

        • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

        • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

        • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

        See Also:
        Action

      • badge

        public final Integer badge()

        The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

        Returns:
        The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

      • body

        public final String body()

        The body of the notification message.

        Returns:
        The body of the notification message.

      • category

        public final String category()

        The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

        Returns:
        The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

      • collapseId

        public final String collapseId()

        An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

        Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

        Returns:
        An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

        Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

      • hasData

        public final boolean hasData()
        For responses, this returns true if the service returned a value for the Data property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • data

        public final Map<String,​String> data()

        The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasData() method.

        Returns:
        The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

      • mediaUrl

        public final String mediaUrl()

        The URL of an image or video to display in the push notification.

        Returns:
        The URL of an image or video to display in the push notification.

      • preferredAuthenticationMethod

        public final String preferredAuthenticationMethod()

        The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

        Returns:
        The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

      • priority

        public final String priority()

        para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

        /listitem>

      • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

        • /para>

        Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

        The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

Returns:
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

  • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

    • /para>

    Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

    The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.