Interface PushAPNSMessageTemplateContent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PushAPNSMessageTemplateContent.Builder,PushAPNSMessageTemplateContent>, SdkBuilder<PushAPNSMessageTemplateContent.Builder,PushAPNSMessageTemplateContent>, SdkPojo
Enclosing class:
PushAPNSMessageTemplateContent
@Mutable @NotThreadSafe public static interface PushAPNSMessageTemplateContent.Builder extends SdkPojo, CopyableBuilder<PushAPNSMessageTemplateContent.Builder,PushAPNSMessageTemplateContent>

  • Method Details

    • title

      PushAPNSMessageTemplateContent.Builder title(String title)

      The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

      Parameters:
      title - The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      PushAPNSMessageTemplateContent.Builder body(MessageTemplateBodyContentProvider body)

      The message body to use in a push notification that is based on the message template.

      Parameters:
      body - The message body to use in a push notification that is based on the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      default PushAPNSMessageTemplateContent.Builder body(Consumer<MessageTemplateBodyContentProvider.Builder> body)

      The message body to use in a push notification that is based on the message template.

      This is a convenience method that creates an instance of the MessageTemplateBodyContentProvider.Builder avoiding the need to create one manually via MessageTemplateBodyContentProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to body(MessageTemplateBodyContentProvider).

      Parameters:
      body - a consumer that will call methods on MessageTemplateBodyContentProvider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      PushAPNSMessageTemplateContent.Builder action(String action)

      The action to occur if a recipient taps a push notification that is based on the message template. 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 action 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.

      Parameters:
      action - The action to occur if a recipient taps a push notification that is based on the message template. 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 action 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      PushAPNSMessageTemplateContent.Builder action(PushMessageAction action)

      The action to occur if a recipient taps a push notification that is based on the message template. 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 action 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.

      Parameters:
      action - The action to occur if a recipient taps a push notification that is based on the message template. 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 action 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sound

      PushAPNSMessageTemplateContent.Builder sound(String sound)

      The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

      Parameters:
      sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • url

      PushAPNSMessageTemplateContent.Builder url(String url)

      The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.

      Parameters:
      url - The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mediaUrl

      PushAPNSMessageTemplateContent.Builder mediaUrl(String mediaUrl)

      The URL of an image or video to display in push notifications that are based on the message template.

      Parameters:
      mediaUrl - The URL of an image or video to display in push notifications that are based on the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rawContent

      PushAPNSMessageTemplateContent.Builder rawContent(MessageTemplateBodyContentProvider rawContent)

      The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

      Parameters:
      rawContent - The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rawContent

      default PushAPNSMessageTemplateContent.Builder rawContent(Consumer<MessageTemplateBodyContentProvider.Builder> rawContent)

      The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

      This is a convenience method that creates an instance of the MessageTemplateBodyContentProvider.Builder avoiding the need to create one manually via MessageTemplateBodyContentProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rawContent(MessageTemplateBodyContentProvider).

      Parameters:
      rawContent - a consumer that will call methods on MessageTemplateBodyContentProvider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: