Interface AndroidPushNotificationTemplate.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>, SdkBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>, SdkPojo
Enclosing class:
AndroidPushNotificationTemplate
public static interface AndroidPushNotificationTemplate.Builder extends SdkPojo, CopyableBuilder<AndroidPushNotificationTemplate.Builder,AndroidPushNotificationTemplate>

  • Method Details

    • action

      AndroidPushNotificationTemplate.Builder action(String action)

      The action to occur if a recipient taps a push notification that's 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 Android 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's 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 Android 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

      AndroidPushNotificationTemplate.Builder action(Action action)

      The action to occur if a recipient taps a push notification that's 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 Android 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's 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 Android 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:

    • body

      AndroidPushNotificationTemplate.Builder body(String body)

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

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

    • imageIconUrl

      AndroidPushNotificationTemplate.Builder imageIconUrl(String imageIconUrl)

      The URL of the large icon image to display in the content view of a push notification that's based on the message template.

      Parameters:
      imageIconUrl - The URL of the large icon image to display in the content view of a push notification that's based on the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageUrl

      AndroidPushNotificationTemplate.Builder imageUrl(String imageUrl)

      The URL of an image to display in a push notification that's based on the message template.

      Parameters:
      imageUrl - The URL of an image to display in a push notification that's based on the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rawContent

      AndroidPushNotificationTemplate.Builder rawContent(String 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.

    • smallImageIconUrl

      AndroidPushNotificationTemplate.Builder smallImageIconUrl(String smallImageIconUrl)

      The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

      Parameters:
      smallImageIconUrl - The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sound

      AndroidPushNotificationTemplate.Builder sound(String sound)

      The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

      Parameters:
      sound - The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      AndroidPushNotificationTemplate.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.

    • url

      AndroidPushNotificationTemplate.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.