firebase-messaging/com.google.firebase.messaging/RemoteMessage/Notification

Notification

The notification payload of a message, as the Android SDK's RemoteMessage.Notification; the image and link URLs are imageUrl and link extensions.

expect class Notification(source)

The notification payload of a message, as the Android SDK's RemoteMessage.Notification; the image and link URLs are imageUrl and link extensions.

actual class Notification(source)

The notification payload of a message, as the Android SDK's RemoteMessage.Notification; the image and link URLs are imageUrl and link extensions.

Properties

body

actual val body: String?

The body text.

expect val body: String?

The body text.

actual val body: String?

The body text.

bodyLocalizationArgs

actual val bodyLocalizationArgs: Array<String>?

The arguments of the localized body.

expect val bodyLocalizationArgs: Array<String>?

The arguments of the localized body.

actual val bodyLocalizationArgs: Array<String>?

The arguments of the localized body.

bodyLocalizationKey

actual val bodyLocalizationKey: String?

The key of the localized body in the app's string resources.

expect val bodyLocalizationKey: String?

The key of the localized body in the app's string resources.

actual val bodyLocalizationKey: String?

The key of the localized body in the app's string resources.

channelId

actual val channelId: String?

The Android notification channel.

expect val channelId: String?

The Android notification channel.

actual val channelId: String?

The Android notification channel.

clickAction

actual val clickAction: String?

The action taken when the notification is tapped.

expect val clickAction: String?

The action taken when the notification is tapped.

actual val clickAction: String?

The action taken when the notification is tapped.

color

actual val color: String?

The notification colour, as #rrggbb.

expect val color: String?

The notification colour, as #rrggbb.

actual val color: String?

The notification colour, as #rrggbb.

defaultLightSettings

actual val defaultLightSettings: Boolean

Whether the default light settings are used.

expect val defaultLightSettings: Boolean

Whether the default light settings are used.

actual val defaultLightSettings: Boolean

Whether the default light settings are used.

defaultSound

actual val defaultSound: Boolean

Whether the default sound is used.

expect val defaultSound: Boolean

Whether the default sound is used.

actual val defaultSound: Boolean

Whether the default sound is used.

defaultVibrateSettings

actual val defaultVibrateSettings: Boolean

Whether the default vibration settings are used.

expect val defaultVibrateSettings: Boolean

Whether the default vibration settings are used.

actual val defaultVibrateSettings: Boolean

Whether the default vibration settings are used.

eventTime

actual val eventTime: Long?

The event time, in milliseconds since the epoch.

expect val eventTime: Long?

The event time, in milliseconds since the epoch.

actual val eventTime: Long?

The event time, in milliseconds since the epoch.

icon

actual val icon: String?

The icon resource name.

expect val icon: String?

The icon resource name.

actual val icon: String?

The icon resource name.

imageUrl

val imageUrl: Uri?

The SDK's Uri members; common code uses the String extensions of RemoteMessageUri.kt, which bind to these.

imageUrl

actual val RemoteMessage.Notification.imageUrl: String?

The URL of the notification image, if any.

expect val RemoteMessage.Notification.imageUrl: String?

The URL of the notification image, if any.

actual val RemoteMessage.Notification.imageUrl: String?

The URL of the notification image, if any.

lightSettings

actual val lightSettings: IntArray?

The LED colour, on and off durations.

expect val lightSettings: IntArray?

The LED colour, on and off durations.

actual val lightSettings: IntArray?

The LED colour, on and off durations.

link

val link: Uri?

link

actual val RemoteMessage.Notification.link: String?

The link opened when the notification is tapped, if any.

expect val RemoteMessage.Notification.link: String?

The link opened when the notification is tapped, if any.

actual val RemoteMessage.Notification.link: String?

The link opened when the notification is tapped, if any.

localOnly

actual val localOnly: Boolean

Whether the notification is local to the device.

expect val localOnly: Boolean

Whether the notification is local to the device.

actual val localOnly: Boolean

Whether the notification is local to the device.

notificationCount

actual val notificationCount: Int?

The number of items the notification represents.

expect val notificationCount: Int?

The number of items the notification represents.

actual val notificationCount: Int?

The number of items the notification represents.

notificationPriority

actual val notificationPriority: Int?

The Android notification priority.

expect val notificationPriority: Int?

The Android notification priority.

actual val notificationPriority: Int?

The Android notification priority.

sound

actual val sound: String?

The sound resource name.

expect val sound: String?

The sound resource name.

actual val sound: String?

The sound resource name.

sticky

actual val sticky: Boolean

Whether the notification persists when tapped.

expect val sticky: Boolean

Whether the notification persists when tapped.

actual val sticky: Boolean

Whether the notification persists when tapped.

tag

actual val tag: String?

The notification tag.

expect val tag: String?

The notification tag.

actual val tag: String?

The notification tag.

ticker

actual val ticker: String?

The ticker text.

expect val ticker: String?

The ticker text.

actual val ticker: String?

The ticker text.

title

actual val title: String?

The title.

expect val title: String?

The title.

actual val title: String?

The title.

titleLocalizationArgs

actual val titleLocalizationArgs: Array<String>?

The arguments of the localized title.

expect val titleLocalizationArgs: Array<String>?

The arguments of the localized title.

actual val titleLocalizationArgs: Array<String>?

The arguments of the localized title.

titleLocalizationKey

actual val titleLocalizationKey: String?

The key of the localized title in the app's string resources.

expect val titleLocalizationKey: String?

The key of the localized title in the app's string resources.

actual val titleLocalizationKey: String?

The key of the localized title in the app's string resources.

vibrateTimings

actual val vibrateTimings: LongArray?

The vibration pattern.

expect val vibrateTimings: LongArray?

The vibration pattern.

actual val vibrateTimings: LongArray?

The vibration pattern.

visibility

actual val visibility: Int?

The Android notification visibility.

expect val visibility: Int?

The Android notification visibility.

actual val visibility: Int?

The Android notification visibility.