Interface PushFCMMessageTemplateContent.Builder

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

  • Method Details

    • title

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

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

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

      PushFCMMessageTemplateContent.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 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 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 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:

    • sound

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

    • url

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

    • imageUrl

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

    • imageIconUrl

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

    • smallImageIconUrl

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

    • rawContent

      PushFCMMessageTemplateContent.Builder rawContent(MessageTemplateBodyContentProvider rawContent)

      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:
      rawContent - 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.

    • rawContent

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

      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.

      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: