Firebase.Messaging.FirebaseNotification

Used for messages that display a notification.

Summary

On android, this requires that the app is using the Play Services client library.

Inheritance

Inherits from: SystemIDisposable

Constructors and Destructors

FirebaseNotification()

Properties

Badge
string
Indicates the badge on the client app home icon. iOS only.
Body
string
Indicates notification body text.
BodyLocalizationArgs
global::System.Collections.Generic.IEnumerable< string >
Indicates the string value to replace format specifiers in body string for localization.
BodyLocalizationKey
string
Indicates the key to the body string for localization.
ClickAction
string
The action associated with a user click on the notification.
Color
string
Indicates color of the icon, expressed in #rrggbb format. Android only.
Icon
string
Indicates notification icon.
Sound
string
Indicates a sound to play when the device receives the notification.
Tag
string
Indicates whether each notification results in a new entry in the notification drawer on Android.
Title
string
Indicates notification title.
TitleLocalizationArgs
global::System.Collections.Generic.IEnumerable< string >
Indicates the string value to replace format specifiers in title string for localization.
TitleLocalizationKey
string
Indicates the key to the title string for localization.

Public functions

Dispose()
void

Properties

Badge

string Badge

Indicates the badge on the client app home icon. iOS only.

Body

string Body

Indicates notification body text.

BodyLocalizationArgs

global::System.Collections.Generic.IEnumerable< string > BodyLocalizationArgs

Indicates the string value to replace format specifiers in body string for localization.

On iOS, this corresponds to "loc-args" in APNS payload.

On Android, these are the format arguments for the string resource. For more information, see Formatting strings.

BodyLocalizationKey

string BodyLocalizationKey

Indicates the key to the body string for localization.

On iOS, this corresponds to "loc-key" in APNS payload.

On Android, use the key in the app's string resources when populating this value.

ClickAction

string ClickAction

The action associated with a user click on the notification.

On Android, if this is set, an activity with a matching intent filter is launched when user clicks the notification.

If set on iOS, corresponds to category in APNS payload.

Color

string Color

Indicates color of the icon, expressed in #rrggbb format. Android only.

Icon

string Icon

Indicates notification icon.

Sets value to myicon for drawable resource myicon.

Sound

string Sound

Indicates a sound to play when the device receives the notification.

Supports default, or the filename of a sound resource bundled in the app.

Android sound files must reside in /res/raw/, while iOS sound files can be in the main bundle of the client app or in the Library/Sounds folder of the app’s data container.

Tag

string Tag

Indicates whether each notification results in a new entry in the notification drawer on Android.

If not set, each request creates a new notification. If set, and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.

Title

string Title

Indicates notification title.

This field is not visible on iOS phones and tablets.

TitleLocalizationArgs

global::System.Collections.Generic.IEnumerable< string > TitleLocalizationArgs

Indicates the string value to replace format specifiers in title string for localization.

On iOS, this corresponds to "title-loc-args" in APNS payload.

On Android, these are the format arguments for the string resource. For more information, see Formatting strings.

TitleLocalizationKey

string TitleLocalizationKey

Indicates the key to the title string for localization.

On iOS, this corresponds to "title-loc-key" in APNS payload.

On Android, use the key in the app's string resources when populating this value.

Public functions

Dispose

void Dispose()

FirebaseNotification

 FirebaseNotification()

Send feedback about...

Need help? Visit our support page.