JsNotificationsWeb class

A web implementation of the JsNotificationsPlatform of the JsNotifications plugin.

Inheritance

• Object
• PlatformInterface
• JsNotificationsPlatform
• JsNotificationsWeb

Constructors

JsNotificationsWeb.protected()

factory

Properties

actionStream → Stream<NotificationActionResult>

Stream broadcasting notification click events with associated data & action

no setter, override

dismissStream → Stream<NotificationActionResult>

Stream broadcasting notification close events with associated data

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

hasPermissions → bool

Convenience method checking browser notification support, wrapper for Dart's native JS notification Notification.permission

no setter, override

isInitialized → bool

Whether the service worker is registered and ready. See initialize.

no setter, override

isSupported → bool

Convenience method checking browser notification support, wrapper for dart's native JS notification Notification.supported

no setter, override

notificationsAPI → NotificationsAPI

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scopeUrl ← String

Updates the scope the plugin's service worker is registered under by re-registering the currently registered worker script (bundled or custom) with value as its scope. Fire-and-forget — prefer registerServiceWorker to await completion, register a custom worker script, or both.

no getter, override

serviceWorkerManager ↔ ServiceWorkerManager

late, final

tapStream → Stream<NotificationActionResult>

Stream broadcasting notification tap events with associated data

no setter, override

Methods

addNotification(JSNotification notification) → Future<void>

Send notification with interop.JSNotification to service worker

override

clearNotifications() → Future<void>

Clear all notifications

override

dismissNotification({required String id}) → Future<void>

Dismiss notification with ID

override

dispose() → Future<void>

override

getAllNotifications() → Future<List<JSNotification>>

Get all notifications

override

getNotification(String tag) → Future<JSNotification?>

Get notification by tag

override

getNotificationTags() → Future<List<String>>

Get all notification tags

override

getPlatformVersion() → Future<String?>

Returns a String containing the version of the platform.

override

initialize() → Future<bool>

Completes when the plugin's service worker has been registered and its event listeners attached.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerServiceWorker({String? url, String? scope}) → Future<void>

Re-registers the plugin's service worker with a custom url and/or scope, replacing the automatically registered bundled worker.

override

requestPermissions() → Future<bool>

Convenience method checking browser notification support, wrapper for Dart's native JS notification Notification.requestPermission(). Returns true if response matches 'granted'.

override

sendAction(Map<String, dynamic> data, {String? id}) → Future<void>

Send action to service worker

override

showNotification(String title, {List<JSNotificationAction>? actions, String? badge, String? body, Map<String, dynamic>? data, JSNotificationDirection? dir, String? icon, String? image, String? lang, bool? renotify, bool? requireInteraction, bool? silent, String? tag, int? timestamp, List<int>? vibrate}) → Future<void>

Send notification with customizable parameters to service worker

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

registerWith(Registrar registrar) → void