Package com.sap.mobile.services.client.push

Class ApnsNotification.Builder

java.lang.Object
com.sap.mobile.services.client.push.ApnsNotification.Builder
Enclosing interface:
ApnsNotification
public static final class ApnsNotification.Builder extends Object
APNS specific notification properties. See
See Also:

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • expiration

      public ApnsNotification.Builder expiration(Date expiration)
      expire notification at given timestamp

    • category

      public ApnsNotification.Builder category(String category)
      Mobile apps can register actions during launch grouped as category. This value allows actions to be executed directly by the notification in the notification center.

    • contentAvailable

      public ApnsNotification.Builder contentAvailable(Boolean contentAvailable)
      Content available marks background notification without visual text.

    • pushType

      public ApnsNotification.Builder pushType(PushType pushType)
      Push Type, see
      See Also:

    • customValues

      public ApnsNotification.Builder customValues(String customValues)
      Custom values for APNS only

    • sound

      public ApnsNotification.Builder sound(String sound)
      Deprecated.
      please use customSound
      Reference to a sound resource in the app. default will play the system sound

    • customSound

      public ApnsNotification.Builder customSound(ApnsCustomSound customSound)
      Detailed APNS sound definition. Use this when sending critical notifications.

    • topic

      public ApnsNotification.Builder topic(String topic)
      The topic for the notification. In general, the topic is your app’s bundle ID/app ID. It can have a suffix based on the type of push notification.

    • alertBody

      public ApnsNotification.Builder alertBody(String alertBody)
      The notification body. localizedAlertKey should be used to retrieve the subtitle from the localized resources of the app based on the user's language configuration when sending templated messages.

    • localizedAlertKey

      public ApnsNotification.Builder localizedAlertKey(String localizedAlertKey)
      Should be used to retrieve the title from the localized resources of the app based on the user's language configuration.

    • localizedAlertArguments

      public ApnsNotification.Builder localizedAlertArguments(List<String> localizedAlertArguments)
      Localization arguments for the body

    • alertTitle

      public ApnsNotification.Builder alertTitle(String alertTitle)
      The notification title. localizedAlertTitleKey should be used to retrieve the subtitle from the localized resources of the app based on the user's language configuration when sending templated messages.

    • localizedAlertTitleKey

      public ApnsNotification.Builder localizedAlertTitleKey(String localizedAlertTitleKey)
      Should be used to retrieve the title from the localized resources of the app based on the user's language configuration.

    • localizedAlertTitleArguments

      public ApnsNotification.Builder localizedAlertTitleArguments(List<String> localizedAlertTitleArguments)
      Localization arguments for the title

    • alertSubtitle

      public ApnsNotification.Builder alertSubtitle(String alertSubtitle)
      The notification subtitle. localizedAlertSubtitleKey should be used to retrieve the subtitle from the localized resources of the app based on the user's language configuration when sending templated messages.

    • localizedAlertSubtitleKey

      public ApnsNotification.Builder localizedAlertSubtitleKey(String localizedAlertSubtitleKey)
      Should be used to retrieve the subtitle from the localized resources of the app based on the user's language configuration.

    • localizedAlertSubtitleArguments

      public ApnsNotification.Builder localizedAlertSubtitleArguments(List<String> localizedAlertSubtitleArguments)
      Localization arguments for the subtitle

    • launchImageFileName

      public ApnsNotification.Builder launchImageFileName(String launchImageFileName)
      The name of the image or storyboard to use when your app launches because of the notification.

    • showActionButton

      public ApnsNotification.Builder showActionButton(Boolean showActionButton)
      Safari only: Show notification action button

    • actionButtonLabel

      public ApnsNotification.Builder actionButtonLabel(String actionButtonLabel)
      Safari only: The literal text of the action button to be shown for the push notification.

    • localizedActionButtonKey

      public ApnsNotification.Builder localizedActionButtonKey(String localizedActionButtonKey)
      Safari only: Localized key of the action button to be shown for the push notification.

    • urlArguments

      public ApnsNotification.Builder urlArguments(List<String> urlArguments)
      List of arguments to populate placeholders in the urlFormatString associated with a Safari push notification.

    • threadId

      public ApnsNotification.Builder threadId(String threadId)
      Thread-Ids allows grouping of notification on application level

    • mutableContent

      public ApnsNotification.Builder mutableContent(Boolean mutableContent)
      Notifications with mutable content set and no visual alert is defined are processed by the mobile app, prior displayed in the notification center

    • interruptionLevel

      public ApnsNotification.Builder interruptionLevel(InterruptionLevel interruptionLevel)
      The interruption-level is optional and defines the importance and delivery timing of a notification

    • targetContentId

      public ApnsNotification.Builder targetContentId(String targetContentId)
      The identifier of the window brought forward. The value of this key will be populated on the UNNotificationContent object created from the push payload.

    • relevanceScore

      public ApnsNotification.Builder relevanceScore(Float relevanceScore)
      The relevance score, a number between 0 and 1, that the system uses to sort the notifications from your app. The highest score gets featured in the notification summary.

    • build

      public ApnsNotification build()