AndroidNotificationDetails class
Contains notification details specific to Android.
Constructors
-
AndroidNotificationDetails(String channelId, String channelName, {String? channelDescription, String? icon, Importance importance = Importance.defaultImportance, Priority priority = Priority.defaultPriority, StyleInformation? styleInformation, bool playSound = true, AndroidNotificationSound? sound, bool enableVibration = true, Int64List? vibrationPattern, String? groupKey, bool setAsGroupSummary = false, GroupAlertBehavior groupAlertBehavior = GroupAlertBehavior.all, bool autoCancel = true, bool ongoing = false, bool silent = false, Color? color, AndroidBitmap<
Object> ? largeIcon, bool onlyAlertOnce = false, bool showWhen = true, int? when, bool usesChronometer = false, bool chronometerCountDown = false, bool channelShowBadge = true, bool showProgress = false, int maxProgress = 0, int progress = 0, bool indeterminate = false, AndroidNotificationChannelAction channelAction = AndroidNotificationChannelAction.createIfNotExists, bool enableLights = false, Color? ledColor, int? ledOnMs, int? ledOffMs, String? ticker, NotificationVisibility? visibility, int? timeoutAfter, AndroidNotificationCategory? category, bool fullScreenIntent = false, String? shortcutId, Int32List? additionalFlags, String? subText, String? tag, List<AndroidNotificationAction> ? actions, bool colorized = false, int? number, AudioAttributesUsage audioAttributesUsage = AudioAttributesUsage.notification}) -
Constructs an instance of AndroidNotificationDetails.
const
Properties
-
actions
→ List<
AndroidNotificationAction> ? -
Specify a list of actions associated with this notifications.
final
- additionalFlags → Int32List?
-
Specifies the additional flags.
final
- audioAttributesUsage → AudioAttributesUsage
-
The attribute describing what is the intended use of the audio signal,
such as alarm or ringtone set in
AudioAttributes.Builderhttps://developer.android.com/reference/android/media/AudioAttributesfinal - autoCancel → bool
-
Specifies if the notification should automatically dismissed upon tapping
on it.
final
- category → AndroidNotificationCategory?
-
The notification category.
final
- channelAction → AndroidNotificationChannelAction
-
The action to take for managing notification channels.
final
- channelDescription → String?
-
The channel's description.
final
- channelId → String
-
The channel's id.
final
- channelName → String
-
The channel's name.
final
- channelShowBadge → bool
-
Whether notifications posted to this channel can appear as application
icon badges in a Launcher
final
- chronometerCountDown → bool
-
Sets the chronometer to count down instead of counting up.
final
- color → Color?
-
Specifies the color.
final
- colorized → bool
-
Specify coloring background should be enabled, if false, color will be
applied to app icon.
final
- enableLights → bool
-
Indicates if lights should be enabled when the notification is displayed.
final
- enableVibration → bool
-
Indicates if vibration should be enabled when the notification is
displayed.
final
- fullScreenIntent → bool
-
Specifies whether the notification should launch a full-screen intent as
soon as it triggers.
final
- groupAlertBehavior → GroupAlertBehavior
-
Specifies the group alert behavior for this notification.
final
- groupKey → String?
-
Specifies the group that this notification belongs to.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → String?
-
The icon that should be used when displaying the notification.
final
- importance → Importance
-
The importance of the notification.
final
- indeterminate → bool
-
Specifies if an indeterminate progress bar will be shown.
final
-
largeIcon
→ AndroidBitmap<
Object> ? -
Specifics the large icon to use.
final
- ledColor → Color?
-
Specifies the light color of the notification.
final
- ledOffMs → int?
-
Specifies how long the light colour will remain off.
final
- ledOnMs → int?
-
Specifies how long the light colour will remain on.
final
- maxProgress → int
-
The maximum progress value.
final
- number → int?
-
Set custom notification count.
final
- ongoing → bool
-
Specifies if the notification will be "ongoing".
final
- onlyAlertOnce → bool
-
Specifies if you would only like the sound, vibrate and ticker to be
played if the notification is not already showing.
final
- playSound → bool
-
Indicates if a sound should be played when the notification is displayed.
final
- priority → Priority
-
The priority of the notification
final
- progress → int
-
The current progress value.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- setAsGroupSummary → bool
-
Specifies if this notification will function as the summary for grouped
notifications.
final
- shortcutId → String?
-
Specifies the id of a published, long-lived sharing that the notification
will be linked to.
final
- showProgress → bool
-
Specifies if the notification will be used to show progress.
final
- showWhen → bool
-
Specifies if the notification should display the timestamp of when it
occurred.
final
- silent → bool
-
Specifies if the notification will be "silent".
final
- sound → AndroidNotificationSound?
-
The sound to play for the notification.
final
- styleInformation → StyleInformation?
-
Specifies the information of the rich notification style to apply to the
notification.
final
- subText → String?
-
Provides some additional information that is displayed in the
notification.
final
- tag → String?
-
The notification tag.
final
- ticker → String?
-
Specifies the "ticker" text which is sent to accessibility services.
final
- timeoutAfter → int?
-
The duration in milliseconds after which the notification will be
cancelled if it hasn't already.
final
- usesChronometer → bool
-
Show when as a stopwatch.
final
- vibrationPattern → Int64List?
-
Configures the vibration pattern.
final
- visibility → NotificationVisibility?
-
Defines the notification visibility on the lockscreen.
final
- when → int?
-
Specifies the timestamp of the notification.
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