MessagingOptions class

Interface representing the options that can be provided when sending a message via the FCM legacy APIs.

See Build send requests for code samples and detailed documentation.

Constructors

MessagingOptions({bool? dryRun, String? priority, int? timeToLive, String? collapseKey, bool? mutableContent, bool? contentAvailable, String? restrictedPackageName})
Interface representing the options that can be provided when sending a message via the FCM legacy APIs.

Properties

collapseKey → String?
String identifying a group of messages (for example, "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is used to avoid sending too many of the same messages when the device comes back online or becomes active.
final
contentAvailable → bool?
On iOS, use this field to represent content-available in the APNs payload. When a notification or data message is sent and this is set to true, an inactive client app is awoken. On Android, data messages wake the app by default. On Chrome, this flag is currently not supported.
final
dryRun → bool?
Whether or not the message should actually be sent. When set to true, allows developers to test a request without actually sending a message. When set to false, the message will be sent.
final
hashCode → int
The hash code for this object.
no setterinherited
mutableContent → bool?
On iOS, use this field to represent mutable-content in the APNs payload. When a notification is sent and this is set to true, the content of the notification can be modified before it is displayed, using a Notification Service app extension.
final
priority → String?
The priority of the message. Valid values are "normal" and "high". On iOS, these correspond to APNs priorities 5 and 10.
final
restrictedPackageName → String?
The package name of the application which the registration tokens must match in order to receive the message.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeToLive → int?
How long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is four weeks, and the default value is also four weeks. For more information, see Setting the lifespan of a message.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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