NotificationPayload class abstract

Interface representing an FCM legacy API notification message payload. Notification messages let developers send up to 4KB of predefined key-value pairs. Accepted keys are outlined below.

See Build send requests for code samples and detailed documentation.

Annotations

@BuiltValue.new()

Constructors

NotificationPayload([void updates(NotificationPayloadBuilder b)?]): factory

Properties

badge → String?: The value of the badge on the home screen app icon.
no setter
body → String?: The notification's body text.
no setter
bodyLocArgs → String?: Variable string values to be used in place of the format specifiers in body_loc_key to use to localize the body text to the user's current localization.
no setter
bodyLocKey → String?: The key to the body string in the app's string resources to use to localize the body text to the user's current localization.
no setter
clickAction → String?: Action associated with a user click on the notification. If specified, an activity with a matching Intent Filter is launched when a user clicks on the notification.
no setter
color → String?: The notification icon's color, expressed in #rrggbb format.
no setter
hashCode → int: The hash code for this object.
no setterinherited
icon → String?: The notification's icon.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sound → String?: The sound to be played when the device receives a notification. Supports "default" for the default notification sound of the device or the filename of a sound resource bundled in the app. Sound files must reside in /res/raw/.
no setter
tag → String?: Identifier used to replace existing notifications in the notification drawer.
no setter
title → String?: The notification's title.
no setter
titleLocArgs → String?: Variable string values to be used in place of the format specifiers in title_loc_key to use to localize the title text to the user's current localization.
no setter
titleLocKey → String?: The key to the title string in the app's string resources to use to localize the title text to the user's current localization.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(NotificationPayloadBuilder)) → NotificationPayload: Rebuilds the instance.
inherited
toBuilder() → NotificationPayloadBuilder: Converts the instance to a builder B.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

serializer → Serializer<NotificationPayload>: no setter