FirebaseAdmin.Messaging.WebpushNotification

Represents the Webpush-specific notification options that can be included in a Message.

Summary

Supports most standard options defined in the Web Notification specification.

Properties

Actions
IEnumerable< Action >
Gets or sets a collection of Webpush notification actions.
Badge
string
Gets or sets the URL of the image used to represent the notification when there is not enough space to display the notification itself.
Body
string
Gets or sets the body text of the notification.
CustomData
IDictionary< string, object >
Gets or sets the custom key-value pairs that will be included in the notification.
Data
object
Gets or sets some arbitrary data that will be included in the notification.
Direction
Gets or sets the direction in which to display the notification.
Icon
string
Gets or sets the URL to the icon of the notification.
Image
string
Gets or sets the URL of an image to be displayed in the notification.
Language
string
Gets or sets the language of the notification.
Renotify
bool
Gets or sets whether the user should be notified after a new notification replaces an old one.
RequireInteraction
bool
Gets or sets whether the notification should remain active until the user clicks or dismisses it, rather than closing it automatically.
Silent
bool
Gets or sets whether the notification should be silent.
Tag
string
Gets or sets an identifying tag for the notification.
TimestampMillis
long
Gets or sets the notification's timestamp value in milliseconds.
Title
string
Gets or sets the title text of the notification.
Vibrate
int[]
Gets or sets a vibration pattern for the receiving device's vibration hardware.

Properties

Actions

IEnumerable< Action > Actions

Gets or sets a collection of Webpush notification actions.

Badge

string Badge

Gets or sets the URL of the image used to represent the notification when there is not enough space to display the notification itself.

Body

string Body

Gets or sets the body text of the notification.

CustomData

IDictionary< string, object > CustomData

Gets or sets the custom key-value pairs that will be included in the notification.

This is exposed as an IDictionary{TKey, TValue} to support correct deserialization of custom properties.

Data

object Data

Gets or sets some arbitrary data that will be included in the notification.

Direction

Direction Direction

Gets or sets the direction in which to display the notification.

Icon

string Icon

Gets or sets the URL to the icon of the notification.

Image

string Image

Gets or sets the URL of an image to be displayed in the notification.

Language

string Language

Gets or sets the language of the notification.

Renotify

bool Renotify

Gets or sets whether the user should be notified after a new notification replaces an old one.

RequireInteraction

bool RequireInteraction

Gets or sets whether the notification should remain active until the user clicks or dismisses it, rather than closing it automatically.

Silent

bool Silent

Gets or sets whether the notification should be silent.

Tag

string Tag

Gets or sets an identifying tag for the notification.

TimestampMillis

long TimestampMillis

Gets or sets the notification's timestamp value in milliseconds.

Title

string Title

Gets or sets the title text of the notification.

Vibrate

int[] Vibrate

Gets or sets a vibration pattern for the receiving device's vibration hardware.