awesome_notifications library Null safety

Classes

AssertUtils
AwesomeNotifications
BitmapHelper
EXTRACTED FROM bitmap: ^0.0.6 DUE TO BUILD GRADLE INCOMPATIBILITIES
BitmapUtils
CronHelper
Cron helper to set notification repetitions Use the rule bellow to specify your on cron repetition rule or access the website https://www.baeldung.com/cron-expressions to see more details. [...]
DateUtils
Definitions
Emojis
List of ASCII emojis
MapUtils
MediaSourcePrefix
Media source prefix, to identify which treatment should be done to each file path
NotificationActionButton
Notification button to display inside a notification. Since Android 7, icons are displayed only for Media Layout Notifications icon must be a native resource media type [...]
NotificationCalendar
NotificationChannel
A representation of default settings that applies to all notifications with same channel key soundSource needs to be a native resource media type
NotificationContent
Main content of notification If notification has no body or title, it will only be created, but not displayed to the user (background notification).
NotificationInterval
NotificationSchedule
Notification schedule configuration timeZone: time zone reference to this schedule crontabSchedule: Crontab expression as repetition rule (with seconds precision), as described in https://www.baeldung.com/cron-expressions allowWhileIdle: Determines if notification will send, even when the device is in critical situation, such as low battery.
PushNotification
Reference Model to create a new notification schedule and actionButtons are optional
ReceivedAction
All received details of a user action over a Notification
ReceivedNotification
All received details of a notification created or displayed on the system The data field
ResourceImage
Decodes the given Uint8List buffer as an image, associating it with the given scale. [...]
RGBA32BitmapHeader
StringUtils

Extensions

Constants

APP_LIFECYCLE_APP_KILLED → const String
'APP_KILLED'
APP_LIFECYCLE_BACKGROUND → const String
'BACKGROUND'
APP_LIFECYCLE_FOREGROUND → const String
'FOREGROUND'
APR → const String
'APR'
AUG → const String
'AUG'
bitmapPixelLength → const int
4
BROADCAST_FCM_TOKEN → const String
'me.carda.awesome_notifications.services.firebase.TOKEN'
BROADCAST_MESSAGE → const String
'me.carda.awesome_notifications.services.firebase.NOTIFICATION'
CHANNEL_FLUTTER_PLUGIN → const String
'awesome_notifications'
CHANNEL_FORCE_UPDATE → const String
"forceUpdate"
CHANNEL_METHOD_ACTION_RECEIVED → const String
'receivedAction'
CHANNEL_METHOD_CANCEL_ALL_NOTIFICATIONS → const String
'cancelAllNotifications'
CHANNEL_METHOD_CANCEL_ALL_SCHEDULES → const String
'cancelAllSchedules'
CHANNEL_METHOD_CANCEL_NOTIFICATION → const String
'cancelNotification'
CHANNEL_METHOD_CANCEL_SCHEDULE → const String
'cancelSchedule'
CHANNEL_METHOD_CREATE_NOTIFICATION → const String
'createNewNotification'
CHANNEL_METHOD_DISMISS_ALL_NOTIFICATIONS → const String
'dismissAllNotifications'
CHANNEL_METHOD_DISMISS_NOTIFICATION → const String
'dismissNotification'
CHANNEL_METHOD_GET_BADGE_COUNT → const String
'getBadgeCount'
CHANNEL_METHOD_GET_DRAWABLE_DATA → const String
'getDrawableData'
CHANNEL_METHOD_GET_FCM_TOKEN → const String
'getFirebaseToken'
CHANNEL_METHOD_GET_LOCAL_TIMEZONE_IDENTIFIER → const String
'getLocalTimeZoneIdentifier'
CHANNEL_METHOD_GET_NEXT_DATE → const String
'getNextDate'
CHANNEL_METHOD_GET_UTC_TIMEZONE_IDENTIFIER → const String
'getUtcTimeZoneIdentifier'
CHANNEL_METHOD_INITIALIZE → const String
'initialize'
CHANNEL_METHOD_IS_FCM_AVAILABLE → const String
'isFirebaseAvailable'
CHANNEL_METHOD_IS_NOTIFICATION_ALLOWED → const String
'isNotificationAllowed'
CHANNEL_METHOD_LIST_ALL_SCHEDULES → const String
'listAllSchedules'
CHANNEL_METHOD_NEW_FCM_TOKEN → const String
'newTokenReceived'
CHANNEL_METHOD_NOTIFICATION_AT_LAUNCH → const String
'notificationAtLaunch'
CHANNEL_METHOD_NOTIFICATION_CREATED → const String
'notificationCreated'
CHANNEL_METHOD_NOTIFICATION_DISMISSED → const String
'notificationDismissed'
CHANNEL_METHOD_NOTIFICATION_DISPLAYED → const String
'notificationDisplayed'
CHANNEL_METHOD_REMOVE_NOTIFICATION_CHANNEL → const String
'removeNotificationChannel'
CHANNEL_METHOD_REQUEST_NOTIFICATIONS → const String
'requestNotifications'
CHANNEL_METHOD_RESET_BADGE → const String
'resetBadge'
CHANNEL_METHOD_SET_BADGE_COUNT → const String
'setBadgeCount'
CHANNEL_METHOD_SET_NOTIFICATION_CHANNEL → const String
'setNotificationChannel'
DATE_FORMAT → const String
'yyyy-MM-dd HH:mm:ss'
DEC → const String
'DEC'
DEFAULT_ICON → const String
'defaultIcon'
DRAWABLE_RESOURCE_REFERENCE → const String
'drawable'
EXTRA_BROADCAST_FCM_TOKEN → const String
'token'
EXTRA_BROADCAST_MESSAGE → const String
'notification'
FEB → const String
'FEB'
FRI → const String
'FRI'
INITIALIZE_CHANNELS → const String
"initializeChannels"
INITIALIZE_DEBUG_MODE → const String
"debug"
INITIALIZE_DEFAULT_ICON → const String
"defaultIcon"
INVALID_BIG_PICTURE_ERROR_CODE → const String
'INVALID_BIG_PICTURE'
INVALID_DRAWABLE_RESOURCE_ERROR_MESSAGE → const String
'The resource %s could not be found. Please make sure it has been added as a drawable resource to your Android head project.'
INVALID_ICON_ERROR_CODE → const String
'INVALID_ICON'
INVALID_LARGE_ICON_ERROR_CODE → const String
'INVALID_LARGE_ICON'
INVALID_LED_DETAILS_ERROR_CODE → const String
'INVALID_LED_DETAILS'
INVALID_LED_DETAILS_ERROR_MESSAGE → const String
'Must specify both ledOnMs and ledOffMs to configure the blink cycle on older versions of Android before Oreo'
INVALID_RAW_RESOURCE_ERROR_MESSAGE → const String
'The resource %s could not be found. Please make sure it has been added as a raw resource to your Android head project.'
INVALID_SOUND_ERROR_CODE → const String
'INVALID_SOUND'
JAN → const String
'JAN'
JUL → const String
'JUL'
JUN → const String
'JUN'
MAR → const String
'MAR'
MAY → const String
'MAY'
MON → const String
'MON'
NOTIFICATION_ACTION_BUTTONS → const String
'actionButtons'
NOTIFICATION_ACTION_DATE → const String
'actionDate'
NOTIFICATION_ACTION_KEY → const String
'actionKey'
NOTIFICATION_ACTION_LIFECYCLE → const String
'actionLifeCycle'
NOTIFICATION_ALLOW_WHILE_IDLE → const String
'allowWhileIdle'
NOTIFICATION_AUTO_CANCEL → const String
'autoCancel'
NOTIFICATION_BIG_PICTURE → const String
'bigPicture'
NOTIFICATION_BODY → const String
'body'
NOTIFICATION_BOT → const String
'bot'
NOTIFICATION_BUTTON_ACTION_PREFIX → const String
'ACTION_NOTIFICATION'
NOTIFICATION_BUTTON_INPUT → const String
'action_input'
NOTIFICATION_BUTTON_KEY → const String
'key'
NOTIFICATION_BUTTON_LABEL → const String
'label'
NOTIFICATION_BUTTON_TYPE → const String
'buttonType'
NOTIFICATION_BUTTONS → const String
"actionButtons"
NOTIFICATION_CHANNEL_ACTION → const String
'channelAction'
NOTIFICATION_CHANNEL_DESCRIPTION → const String
'channelDescription'
NOTIFICATION_CHANNEL_KEY → const String
'channelKey'
NOTIFICATION_CHANNEL_NAME → const String
'channelName'
NOTIFICATION_CHANNEL_SHOW_BADGE → const String
'channelShowBadge'
NOTIFICATION_COLOR → const String
'color'
NOTIFICATION_CONTENT → const String
"content"
NOTIFICATION_CONVERSATION_TITLE → const String
'conversationTitle'
NOTIFICATION_CREATED_DATE → const String
'createdDate'
NOTIFICATION_CREATED_LIFECYCLE → const String
'createdLifeCycle'
NOTIFICATION_CREATED_SOURCE → const String
'createdSource'
NOTIFICATION_CRONTAB_SCHEDULE → const String
'crontabSchedule'
NOTIFICATION_DATA_MIME_TYPE → const String
'dataMimeType'
NOTIFICATION_DATA_URI → const String
'dataUri'
NOTIFICATION_DEFAULT_PRIVACY → const String
"defaultPrivacy"
NOTIFICATION_DEFAULT_RINGTONE_TYPE → const String
"defaultRingtoneType"
NOTIFICATION_DISPLAYED_DATE → const String
'displayedDate'
NOTIFICATION_DISPLAYED_LIFECYCLE → const String
'displayedLifeCycle'
NOTIFICATION_ENABLE_LIGHTS → const String
'enableLights'
NOTIFICATION_ENABLE_VIBRATION → const String
'enableVibration'
NOTIFICATION_ENABLED → const String
"enabled"
NOTIFICATION_EXPANDABLE_BODY → const String
'expandableBody'
NOTIFICATION_GROUP_ALERT_BEHAVIOR → const String
'groupAlertBehavior'
NOTIFICATION_GROUP_CONVERSATION → const String
'groupConversation'
NOTIFICATION_GROUP_KEY → const String
'groupKey'
NOTIFICATION_GROUP_SORT → const String
'groupSort'
NOTIFICATION_HIDE_LARGE_ICON_ON_EXPAND → const String
'hideLargeIconOnExpand'
NOTIFICATION_ICON → const String
'icon'
NOTIFICATION_ICON_RESOURCE_ID → const String
'iconResourceId'
NOTIFICATION_ID → const String
'id'
NOTIFICATION_IMPORTANCE → const String
'importance'
NOTIFICATION_IMPORTANT → const String
'important'
NOTIFICATION_INDETERMINATE → const String
'indeterminate'
NOTIFICATION_INITIAL_DATE_TIME → const String
'initialDateTime'
NOTIFICATION_INITIAL_FIXED_DATE → const String
'fixedDate'
NOTIFICATION_JSON → const String
'notificationJson'
NOTIFICATION_KEY → const String
'key'
NOTIFICATION_LARGE_ICON → const String
'largeIcon'
NOTIFICATION_LAYOUT → const String
'notificationLayout'
NOTIFICATION_LED_COLOR → const String
'ledColor'
NOTIFICATION_LED_OFF_MS → const String
'ledOffMs'
NOTIFICATION_LED_ON_MS → const String
'ledOnMs'
NOTIFICATION_LOCKED → const String
'locked'
NOTIFICATION_MAX_PROGRESS → const String
'maxProgress'
NOTIFICATION_MESSAGES → const String
'messages'
NOTIFICATION_NAME → const String
'name'
NOTIFICATION_ONLY_ALERT_ONCE → const String
'onlyAlertOnce'
NOTIFICATION_PAYLOAD → const String
'payload'
NOTIFICATION_PERSON → const String
'person'
NOTIFICATION_PLATFORM_CONFIGURATION → const String
'platformConfiguration'
NOTIFICATION_PLAY_SOUND → const String
'playSound'
NOTIFICATION_PRECISE_SCHEDULES → const String
'preciseSchedules'
NOTIFICATION_PRIVACY → const String
"privacy"
NOTIFICATION_PRIVATE_MESSAGE → const String
"privateMessage"
NOTIFICATION_PROGRESS → const String
'progress'
NOTIFICATION_SCHEDULE → const String
"schedule"
NOTIFICATION_SCHEDULE_ALLOW_WHILE_IDLE → const String
'allowWhileIdle'
NOTIFICATION_SCHEDULE_DAY → const String
'day'
NOTIFICATION_SCHEDULE_ERA → const String
'era'
NOTIFICATION_SCHEDULE_HOUR → const String
'hour'
NOTIFICATION_SCHEDULE_INTERVAL → const String
'interval'
NOTIFICATION_SCHEDULE_MILLISECOND → const String
'millisecond'
NOTIFICATION_SCHEDULE_MINUTE → const String
'minute'
NOTIFICATION_SCHEDULE_MONTH → const String
'month'
NOTIFICATION_SCHEDULE_REPEATS → const String
'repeats'
NOTIFICATION_SCHEDULE_SECOND → const String
'second'
NOTIFICATION_SCHEDULE_TIMEZONE → const String
'timeZone'
NOTIFICATION_SCHEDULE_WEEKDAY → const String
'weekday'
NOTIFICATION_SCHEDULE_WEEKOFMONTH → const String
'weekOfMonth'
NOTIFICATION_SCHEDULE_WEEKOFYEAR → const String
'weekOfYear'
NOTIFICATION_SCHEDULE_YEAR → const String
'year'
NOTIFICATION_SHOW_PROGRESS → const String
'showProgress'
NOTIFICATION_SHOW_WHEN → const String
'showWhen'
NOTIFICATION_SOUND_PATH → const String
'sound'
NOTIFICATION_SUMMARY → const String
'summary'
NOTIFICATION_SYSTEM_ID → const String
'id'
NOTIFICATION_TEXT → const String
'text'
NOTIFICATION_TICKER → const String
'ticker'
NOTIFICATION_TIMESTAMP → const String
'timestamp'
NOTIFICATION_TITLE → const String
'title'
NOTIFICATION_URI → const String
'uri'
NOTIFICATION_VIBRATION_PATTERN → const String
'vibrationPattern'
NOV → const String
'NOV'
OCT → const String
'OCT'
PUSH_SOURCE_FIREBASE → const String
'Firebase'
PUSH_SOURCE_LOCAL_NOTIFICATION → const String
'Local'
PUSH_SOURCE_ONE_SIGNAL → const String
'OneSignal'
RGBA32HeaderSize → const int
122
SAT → const String
'SAT'
SCHEDULED_NOTIFICATIONS → const String
'scheduled_notifications'
SELECT_NOTIFICATION → const String
'SELECT_NOTIFICATION'
SEP → const String
'SEP'
SHARED_PREFERENCES_KEY → const String
'notification_plugin_cache'
SUN → const String
'SUN'
THU → const String
'THU'
TUE → const String
'TUE'
WED → const String
'WED'

Properties

highVibrationPattern Int64List
read / write
lowVibrationPattern Int64List
read / write
mediumVibrationPattern Int64List
read / write

Enums

ActionButtonType
Defines the notification button's type ActionButtonType.Default Default button type ActionButtonType.InputField Button when pressed opens a dialog shortcut to send an text response ActionButtonType.DisabledAction Button when pressed should just close the notification in tray, but do not fires respective action ActionButtonType.KeepOnTop Button, when pressed, fires the respective action without close the notification
DefaultRingtoneType
Determines what kind of default sound should be played with the notification Ringtone: Type that refers to sounds that are used for the phone ringer. Notification: Type that refers to sounds that are used for notifications (default). Alarm: Type that refers to sounds that are used for the alarm.
GroupAlertBehavior
Sets the group alert behavior for this notification. Use this method to mute this notification if alerts for this notification's group should be handled by a different notification. This is only applicable for notifications that belong to a group. GroupAlertBehavior.All All notifications in a group with sound or vibration ought to make sound or vibrate (respectively), so this notification will not be muted when it is in a group. GroupAlertBehavior.Summary All children notification in a group should be silenced (no sound or vibration) even if they would otherwise make sound or vibrate. GroupAlertBehavior.Children The summary notification in a group should be silenced (no sound or vibration) even if they would otherwise make sound or vibrate
GroupSort
Determines the grouping sort order GroupSort.Asc Order the notifications inside grouping by ascending order GroupSort.Desc Order the notifications inside grouping by descending order
MediaSource
A reference to where load the media (Image or Sound) to build a notification. There's 4 media types available: [...]
NotificationImportance
Determines the importance to show immeadetly the notification to the user Default: shows everywhere, makes noise, but does not visually intrude. Higher: shows everywhere, makes noise and peeks. May use full screen intents. Low: Shows in the shade, and potentially in the status bar (see shouldHideSilentStatusBarIcons()), but is not audibly intrusive. Min: only shows in the shade, below the fold. This should not be used with Service#startForeground(int, Notification) since a foreground service is supposed to be something the user cares about so it does not make semantic sense to mark its notification as minimum importance. If you do this as of Android version Build.VERSION_CODES.O, the system will show a higher-priority notification about your app running in the background. None: A notification with no importance: does not show in the shade.
NotificationLayout
Notification Layout to be used as reference to build the notification. If is not possible to build the desired layout, use the default one.
NotificationLifeCycle
Application life cycle at new notification change state
NotificationPrivacy
Hides sensitive notifications when the device is on lock screen Public: Show this notification in its entirety on all lockscreens Private: Show this notification on all lockscreens, but conceal sensitive or private information on secure lockscreens Secret: Do not reveal any part of this notification on a secure lockscreen
NotificationSource
Enumerates if notification was created on local source, scheduled notification, Firebase, OneSignal, etc.