Package com.mongodb.stitch.core.services.fcm

Class FcmSendMessageNotification

  • public final class FcmSendMessageNotification
extends Object
    A Notification encapsulates the details of an FCM send message request notification payload.

    • Method Summary

      Modifier and Type Method Description
      String getBadge()
      Returns the value of the badge on the home screen app icon.
      String getBody()
      Returns the notification's body text.
      String getBodyLocArgs()
      Returns the variable string values to be used in place of the format specifiers in bodyLocKey to use to localize the body text to the user's current localization.
      String getBodyLocKey()
      Returns the key to the body string in the app's string resources to use to localize the body text to the user's current localization.
      String getClickAction()
      Returns the action associated with a user click on the notification.
      String getColor()
      Returns the notification's icon color, expressed in #rrggbb format.
      String getIcon()
      Returns the notification's icon.
      String getSound()
      Returns the sound to play when the device receives the notification.
      String getTag()
      Returns the identifier used to replace existing notifications in the notification drawer.
      String getTitle()
      Returns the notification's title.
      String getTitleLocArgs()
      Returns the variable string values to be used in place of the format specifiers in titleLocKey to use to localize the title text to the user's current localization.
      String getTitleLocKey()
      Returns the key to the title string in the app's string resources to use to localize the title text to the user's current localization.

    • Method Detail

      • getTitle

        @Nullable
public String getTitle()
        Returns the notification's title.
        Returns:
        the notification's title.

      • getBody

        @Nullable
public String getBody()
        Returns the notification's body text.
        Returns:
        the notification's body text.

      • getSound

        @Nullable
public String getSound()
        Returns the sound to play when the device receives the notification.
        Returns:
        the sound to play when the device receives the notification.

      • getClickAction

        @Nullable
public String getClickAction()
        Returns the action associated with a user click on the notification.
        Returns:
        the action associated with a user click on the notification.

      • getBodyLocKey

        @Nullable
public String getBodyLocKey()
        Returns the key to the body string in the app's string resources to use to localize the body text to the user's current localization.
        Returns:
        the key to the body string in the app's string resources to use to localize the body text to the user's current localization.

      • getBodyLocArgs

        @Nullable
public String getBodyLocArgs()
        Returns the variable string values to be used in place of the format specifiers in bodyLocKey to use to localize the body text to the user's current localization.
        Returns:
        the variable string values to be used in place of the format specifiers in bodyLocKey to use to localize the body text to the user's current localization.

      • getTitleLocKey

        @Nullable
public String getTitleLocKey()
        Returns the key to the title string in the app's string resources to use to localize the title text to the user's current localization.
        Returns:
        the key to the title string in the app's string resources to use to localize the title text to the user's current localization.

      • getTitleLocArgs

        @Nullable
public String getTitleLocArgs()
        Returns the variable string values to be used in place of the format specifiers in titleLocKey to use to localize the title text to the user's current localization.
        Returns:
        the variable string values to be used in place of the format specifiers in titleLocKey to use to localize the title text to the user's current localization.

      • getIcon

        @Nullable
public String getIcon()
        Returns the notification's icon. Note: for messages to Android devices only.
        Returns:
        the notification's icon.

      • getTag

        @Nullable
public String getTag()
        Returns the identifier used to replace existing notifications in the notification drawer. Note: for messages to Android devices only.
        Returns:
        the identifier used to replace existing notifications in the notification drawer.

      • getColor

        @Nullable
public String getColor()
        Returns the notification's icon color, expressed in #rrggbb format. Note: for messages to Android devices only.
        Returns:
        the notification's icon color, expressed in #rrggbb format.

      • getBadge

        @Nullable
public String getBadge()
        Returns the value of the badge on the home screen app icon. Note: iOS only.
        Returns:
        the value of the badge on the home screen app icon.