RemoteMessage.Notification

class RemoteMessage.Notification


Remote Firebase notification details.

This class maps to the fields of a notification message.

Summary

Public functions

Array<String!>?

Gets the variable string values to be used as format specifiers in the body localization key, or null if not set.

String?

Gets the string resource name to use to localize the body of the notification, or null if not set.

Boolean

Gets whether or not the notification uses the default vibrate pattern.

Uri?

Gets the image URL from the notification.

Array<String!>?

Gets the variable string values to be used as format specifiers in the title localization key, or null if not set.

String?

Gets the string resource name to use to localize the title of the notification, or null if not set.

Public functions

getBodyLocalizationArgs

fun getBodyLocalizationArgs(): Array<String!>?

Gets the variable string values to be used as format specifiers in the body localization key, or null if not set.

getBodyLocalizationKey

fun getBodyLocalizationKey(): String?

Gets the string resource name to use to localize the body of the notification, or null if not set.

getDefaultVibrateSettings

fun getDefaultVibrateSettings(): Boolean

Gets whether or not the notification uses the default vibrate pattern.

See details about defaultVibrateTimings in Firebase Cloud Messaging Reference: HTTP v1 API.

Returns
Boolean

true if it is set to true; Otherwise false.

getImageUrl

fun getImageUrl(): Uri?

Gets the image URL from the notification.

Returns
Uri?

The image URL if it was set, null otherwise.

getTitleLocalizationArgs

fun getTitleLocalizationArgs(): Array<String!>?

Gets the variable string values to be used as format specifiers in the title localization key, or null if not set.

getTitleLocalizationKey

fun getTitleLocalizationKey(): String?

Gets the string resource name to use to localize the title of the notification, or null if not set.

Public properties

body

val bodyString!

channelId

val channelIdString!

clickAction

val clickActionString!

color

val colorString!

defaultLightSettings

val defaultLightSettingsBoolean

defaultSound

val defaultSoundBoolean

eventTime

val eventTimeLong!

icon

val iconString!

lightSettings

val lightSettingsIntArray<Int>!

link

val linkUri!

localOnly

val localOnlyBoolean

notificationCount

val notificationCountInt!

notificationPriority

val notificationPriorityInt!

sound

val soundString!

sticky

val stickyBoolean

tag

val tagString!

ticker

val tickerString!

title

val titleString!

vibrateTimings

val vibrateTimingsLongArray<Long>!

visibility

val visibilityInt!