Skip to content

OpenDBRequest

class OpenDBRequest extends Request

Annotations: @Unstable.new(), @Native.new("IDBOpenDBRequest,IDBVersionChangeRequest")

Inheritance

Object → EventTargetRequestOpenDBRequest

Properties

error no setter inherited

DomException? get error

Inherited from Request.

Implementation
dart
DomException? get error native;

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

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

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
dart
Events get on => new Events(this);

onBlocked no setter

Stream<Event> get onBlocked

Stream of blocked events handled by this OpenDBRequest.

Implementation
dart
Stream<Event> get onBlocked => blockedEvent.forTarget(this);

onError no setter inherited

Stream<Event> get onError

Stream of error events handled by this Request.

Inherited from Request.

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

onSuccess no setter inherited

Stream<Event> get onSuccess

Stream of success events handled by this Request.

Inherited from Request.

Implementation
dart
Stream<Event> get onSuccess => successEvent.forTarget(this);

onUpgradeNeeded no setter

Stream<VersionChangeEvent> get onUpgradeNeeded

Stream of upgradeneeded events handled by this OpenDBRequest.

Implementation
dart
Stream<VersionChangeEvent> get onUpgradeNeeded =>
    upgradeNeededEvent.forTarget(this);

readyState no setter inherited

String? get readyState

Inherited from Request.

Implementation
dart
String? get readyState native;

result no setter inherited

dynamic get result

Inherited from Request.

Implementation
dart
dynamic get result => _convertNativeToDart_IDBAny(this._get_result);

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

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

source no setter inherited

Object? get source

Inherited from Request.

Implementation
dart
@Creates('Null')
Object? get source native;

transaction no setter inherited

Transaction? get transaction

Inherited from Request.

Implementation
dart
Transaction? get transaction native;

Methods

addEventListener() inherited

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

Inherited from EventTarget.

Implementation
dart
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);
  }
}

dispatchEvent() inherited

bool dispatchEvent(Event event)

Inherited from EventTarget.

Implementation
dart
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:

dart
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:

dart
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
dart
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
dart
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
dart
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
dart
bool operator ==(Object other) => identical(this, other);

Constants

blockedEvent

const EventStreamProvider<Event> blockedEvent

Static factory designed to expose blocked events to event handlers that are not necessarily instances of OpenDBRequest.

See EventStreamProvider for usage information.

Implementation
dart
static const EventStreamProvider<Event> blockedEvent =
    const EventStreamProvider<Event>('blocked');

upgradeNeededEvent

const EventStreamProvider<VersionChangeEvent> upgradeNeededEvent

Static factory designed to expose upgradeneeded events to event handlers that are not necessarily instances of OpenDBRequest.

See EventStreamProvider for usage information.

Implementation
dart
static const EventStreamProvider<VersionChangeEvent> upgradeNeededEvent =
    const EventStreamProvider<VersionChangeEvent>('upgradeneeded');