Notification#

class Notification extends EventTarget

Annotations: @Native.new("Notification")

Inheritance

Object → EventTarget → Notification

Constructors#

Notification() factory#

factory Notification( String title, { String? dir, String? body, String? lang, String? tag, String? icon, })

Implementation

factory Notification(
  String title, {
  String? dir,
  String? body,
  String? lang,
  String? tag,
  String? icon,
}) {
  var parsedOptions = {};
  if (dir != null) parsedOptions['dir'] = dir;
  if (body != null) parsedOptions['body'] = body;
  if (lang != null) parsedOptions['lang'] = lang;
  if (tag != null) parsedOptions['tag'] = tag;
  if (icon != null) parsedOptions['icon'] = icon;
  return Notification._factoryNotification(title, parsedOptions);
}

Properties#

actions no setter#

List<dynamic>? get actions

Implementation

List? get actions native;

badge no setter#

String? get badge

Implementation

String? get badge native;

body no setter#

String? get body

Implementation

String? get body native;

data no setter#

Object? get data

Implementation

@annotation_Creates_SerializedScriptValue
@annotation_Returns_SerializedScriptValue
Object? get data native;

dir no setter#

String? get dir

Implementation

String? get dir native;

hashCode no setter inherited#

int get hashCode

Inherited from Interceptor.

Implementation

int get hashCode => Primitives.objectHashCode(this);

icon no setter#

String? get icon

Implementation

String? get icon native;

image no setter#

String? get image

Implementation

String? get image native;

lang no setter#

String? get lang

Implementation

String? get lang native;

on no setter inherited#

Events get on

This is an ease-of-use accessor for event streams which should only be used when an explicit accessor is not available.

Inherited from EventTarget.

Implementation

Events get on => new Events(this);

onClick no setter#

Stream<Event> get onClick

Stream of click events handled by this Notification.

Implementation

Stream<Event> get onClick => clickEvent.forTarget(this);

onClose no setter#

Stream<Event> get onClose

Stream of close events handled by this Notification.

Implementation

Stream<Event> get onClose => closeEvent.forTarget(this);

onError no setter#

Stream<Event> get onError

Stream of error events handled by this Notification.

Implementation

Stream<Event> get onError => errorEvent.forTarget(this);

onShow no setter#

Stream<Event> get onShow

Stream of show events handled by this Notification.

Implementation

Stream<Event> get onShow => showEvent.forTarget(this);

renotify no setter#

bool? get renotify

Implementation

bool? get renotify native;

requireInteraction no setter#

bool? get requireInteraction

Implementation

bool? get requireInteraction native;

runtimeType no setter inherited#

Type get runtimeType

Inherited from Interceptor.

Implementation

Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

silent no setter#

bool? get silent

Implementation

bool? get silent native;

tag no setter#

String? get tag

Implementation

String? get tag native;

timestamp no setter#

int? get timestamp

Implementation

int? get timestamp native;

title no setter#

String? get title

Implementation

String? get title native;

vibrate no setter#

List<int>? get vibrate

Implementation

List<int>? get vibrate native;

Methods#

addEventListener() inherited#

void addEventListener( String type, dynamic Function(Event event)? listener, [ bool? useCapture, ]);

Inherited from EventTarget.

Implementation

void addEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  &#47;&#47; TODO(leafp): This check is avoid a bug in our dispatch code when
  &#47;&#47; listener is null.  The browser treats this call as a no-op in this
  &#47;&#47; case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _addEventListener(type, listener, useCapture);
  }
}

close()#

void close()

Implementation

void close() native;

dispatchEvent() inherited#

bool dispatchEvent(Event event)

Inherited from EventTarget.

Implementation

bool dispatchEvent(Event event) native;

noSuchMethod() inherited#

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation

dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

removeEventListener() inherited#

void removeEventListener( String type, dynamic Function(Event event)? listener, [ bool? useCapture, ]);

Inherited from EventTarget.

Implementation

void removeEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  &#47;&#47; TODO(leafp): This check is avoid a bug in our dispatch code when
  &#47;&#47; listener is null.  The browser treats this call as a no-op in this
  &#47;&#47; case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _removeEventListener(type, listener, useCapture);
  }
}

toString() inherited#

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation

String toString() => Primitives.objectToHumanReadableString(this);

Operators#

operator ==() inherited#

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects o, o == o must be true.
Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.
Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation

bool operator ==(Object other) => identical(this, other);

Static Properties#

maxActions no setter#

int? get maxActions

Implementation

static int? get maxActions native;

permission no setter#

String? get permission

Implementation

static String? get permission native;

supported no setter#

bool get supported

Checks if this type is supported on the current platform.

Implementation

static bool get supported => JS('bool', '!!(window.Notification)');

Static Methods#

requestPermission()#

Future<String> requestPermission()

Implementation

@JSName('requestPermission')
static Future<String> requestPermission() {
  var completer = new Completer<String>();
  _requestPermission((value) {
    completer.complete(value);
  });
  return completer.future;
}

Constants#

clickEvent#

const EventStreamProvider<Event> clickEvent

Static factory designed to expose click events to event handlers that are not necessarily instances of Notification.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> clickEvent =
    const EventStreamProvider<Event>('click');

closeEvent#

const EventStreamProvider<Event> closeEvent

Static factory designed to expose close events to event handlers that are not necessarily instances of Notification.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> closeEvent =
    const EventStreamProvider<Event>('close');

errorEvent#

const EventStreamProvider<Event> errorEvent

Static factory designed to expose error events to event handlers that are not necessarily instances of Notification.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> errorEvent =
    const EventStreamProvider<Event>('error');

showEvent#

const EventStreamProvider<Event> showEvent

Static factory designed to expose show events to event handlers that are not necessarily instances of Notification.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> showEvent =
    const EventStreamProvider<Event>('show');