Stay organized with collections
Save and categorize content based on your preferences.
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
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-03-24 UTC.
[null,null,["Last updated 2022-03-24 UTC."],[],[],null,["# FirebaseAdmin.Messaging.WebpushNotification Class Reference\n\nFirebaseAdmin.Messaging.WebpushNotification\n===========================================\n\nRepresents the Webpush-specific notification options that can be included in a [Message](/docs/reference/admin/dotnet/class/firebase-admin/messaging/message#class_firebase_admin_1_1_messaging_1_1_message).\n\nSummary\n-------\n\nSupports most standard options defined in the [Web Notification specification](https://developer.mozilla.org/en-US/docs/Web/API/notification/Notification).\n\n| ### Properties ||\n|-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Actions](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a348079b311cdc47c2987680b0adfbdcd) | `IEnumerable\u003c `[Action](/docs/reference/admin/dotnet/class/firebase-admin/messaging/action#class_firebase_admin_1_1_messaging_1_1_action)` \u003e` Gets or sets a collection of Webpush notification actions. |\n| [Badge](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a682e99d8f8b90c90a286a96acd7d53a8) | `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. |\n| [Body](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a5c0151723285e683ee58edbb6693469f) | `string` Gets or sets the body text of the notification. |\n| [CustomData](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a76c7844b488dd7925ee362f1b7a2813f) | `IDictionary\u003c string, object \u003e` Gets or sets the custom key-value pairs that will be included in the notification. |\n| [Data](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a9b075ff57ba13a142157846845baa86e) | `object` Gets or sets some arbitrary data that will be included in the notification. |\n| [Direction](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a2de83f6c4296fb36a44db02aa0a215d4) | [Direction](/docs/reference/admin/dotnet/namespace/firebase-admin/messaging#namespace_firebase_admin_1_1_messaging_1ae98b9a366d634a1a4bd33068005c79c7) Gets or sets the direction in which to display the notification. |\n| [Icon](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a5be781d5ec5298fd28c0810aa60f32f3) | `string` Gets or sets the URL to the icon of the notification. |\n| [Image](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1ad088d0121adb1e2a3ca27c7932c34059) | `string` Gets or sets the URL of an image to be displayed in the notification. |\n| [Language](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1afe91072cc3cdc78e330f07f5d2fc9803) | `string` Gets or sets the language of the notification. |\n| [Renotify](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a40bdd0162c8f5dc0a85b4fc08f1af5a7) | `bool` Gets or sets whether the user should be notified after a new notification replaces an old one. |\n| [RequireInteraction](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a6bb6f48caed5dfaeff53dfe67a198593) | `bool` Gets or sets whether the notification should remain active until the user clicks or dismisses it, rather than closing it automatically. |\n| [Silent](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a5b8bb3fe1fd1d7f5e497a2dc587f9929) | `bool` Gets or sets whether the notification should be silent. |\n| [Tag](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a766f81870b4626ba29c8e718dc4b35d9) | `string` Gets or sets an identifying tag for the notification. |\n| [TimestampMillis](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a05e8fc781b0088333d9ec71f338b94f8) | `long` Gets or sets the notification's timestamp value in milliseconds. |\n| [Title](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1a04b2c381c37ea9826781b2920cbee1a2) | `string` Gets or sets the title text of the notification. |\n| [Vibrate](#class_firebase_admin_1_1_messaging_1_1_webpush_notification_1abde827e47bb54dd665c3cec9b616acf3) | `int[]` Gets or sets a vibration pattern for the receiving device's vibration hardware. |\n\nProperties\n----------\n\n### Actions\n\n```text\nIEnumerable\u003c Action \u003e Actions\n``` \nGets or sets a collection of Webpush notification actions. \n\n### Badge\n\n```text\nstring Badge\n``` \nGets or sets the URL of the image used to represent the notification when there is not enough space to display the notification itself. \n\n### Body\n\n```text\nstring Body\n``` \nGets or sets the body text of the notification. \n\n### CustomData\n\n```text\nIDictionary\u003c string, object \u003e CustomData\n``` \nGets or sets the custom key-value pairs that will be included in the notification.\n\nThis is exposed as an IDictionary{TKey, TValue} to support correct deserialization of custom properties. \n\n### Data\n\n```text\nobject Data\n``` \nGets or sets some arbitrary data that will be included in the notification. \n\n### Direction\n\n```text\nDirection Direction\n``` \nGets or sets the direction in which to display the notification. \n\n### Icon\n\n```text\nstring Icon\n``` \nGets or sets the URL to the icon of the notification. \n\n### Image\n\n```text\nstring Image\n``` \nGets or sets the URL of an image to be displayed in the notification. \n\n### Language\n\n```text\nstring Language\n``` \nGets or sets the language of the notification. \n\n### Renotify\n\n```text\nbool Renotify\n``` \nGets or sets whether the user should be notified after a new notification replaces an old one. \n\n### RequireInteraction\n\n```text\nbool RequireInteraction\n``` \nGets or sets whether the notification should remain active until the user clicks or dismisses it, rather than closing it automatically. \n\n### Silent\n\n```text\nbool Silent\n``` \nGets or sets whether the notification should be silent. \n\n### Tag\n\n```text\nstring Tag\n``` \nGets or sets an identifying tag for the notification. \n\n### TimestampMillis\n\n```text\nlong TimestampMillis\n``` \nGets or sets the notification's timestamp value in milliseconds. \n\n### Title\n\n```text\nstring Title\n``` \nGets or sets the title text of the notification. \n\n### Vibrate\n\n```text\nint[] Vibrate\n``` \nGets or sets a vibration pattern for the receiving device's vibration hardware."]]
