Reference extension type

A Reference represents a specific location in your Database and can be used for reading or writing data to that Database location.

on

• JSObject

Implemented types

• Query

Available extensions

• FirebaseJsInteropJSAnyExtension
• JSAnyOperatorExtension
• JSAnyUtilityExtension
• JSObjectUnsafeUtilExtension
• NullableUndefineableJSAnyExtension

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isDefinedAndNotNull → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

no setter

isNull → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

Whether this value corresponds to JavaScript null.

no setter

isTruthy → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of !!this in JavaScript.

no setter

isUndefined → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

Whether this value corresponds to JavaScript undefined.

no setter

isUndefinedOrNull → bool

Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension

no setter

key → String?

The last part of the Reference's path.

no setter

not → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of !this in JavaScript.

no setter

parent → Reference?

The parent location of a Reference.

no setter

ref → Reference

Returns a Reference to the Query's location.

no setter, inherited

root → Reference

The root Reference of the Database.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

add(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this + any in JavaScript.

and(JSAny? any) → JSAny?

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this && any in JavaScript.

callMethod<R extends JSAny?>(JSAny method, [JSAny? arg1, JSAny? arg2, JSAny? arg3, JSAny? arg4]) → R

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Calls method on this JSObject with up to four arguments.

callMethodVarArgs<R extends JSAny?>(JSAny method, [List<JSAny?>? arguments]) → R

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Calls method on this JSObject with a variable number of arguments.

child(String path) → Reference

Gets a Reference for the location at the specified relative path.

dartify() → Object?

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Converts a JavaScript JSON-like value to the Dart equivalent if possible.

delete(JSAny property) → JSBoolean

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Deletes the property with key property from this JSObject.

divide(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this / any in JavaScript.

endAt(JSAny? value, [String key]) → Query

Creates a Query with the specified ending point.

inherited

endBefore(JSAny? value, [String key]) → Query

Creates a Query with the specified ending point (exclusive).

inherited

equals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this == any in JavaScript.

equalTo(JSAny? value, [String key]) → Query

Creates a Query that includes children that match the specified value.

inherited

exponentiate(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this ** any in JavaScript.

get() → JSPromise<DataSnapshot>

Gets the most up-to-date result for this query.

inherited

getProperty<R extends JSAny?>(JSAny property) → R

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

The value of the property key property of this JSObject.

getUrl() → String

Gets the absolute URL for this location.

inherited

greaterThan(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this > any in JavaScript.

greaterThanOrEqualTo(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this >= any in JavaScript.

has(String property) → bool

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Shorthand helper for hasProperty to check whether this JSObject contains the property key property, but takes and returns a Dart value.

hasProperty(JSAny property) → JSBoolean

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Whether or not this JSObject contains the property key property.

instanceof(JSFunction constructor) → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether this JSAny? is an instanceof constructor.

instanceOfString(String constructorName) → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether this JSAny? is an instanceof the constructor that is defined by constructorName, which is looked up in the globalContext.

isA<T extends JSAny?>() → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether this JSAny? is an instance of the JavaScript type that is declared by T.

isEqual(Query? other) → bool

Returns whether or not the current and provided queries represent the same location, have the same query parameters, and are from the same instance of firebase.app.App.

inherited

lessThan(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this < any in JavaScript.

lessThanOrEqualTo(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this <= any in JavaScript.

limitToFirst(int limit) → Query

Generates a new Query limited to the first specific number of children.

inherited

limitToLast(int limit) → Query

Generates a new Query object limited to the last specific number of children.

inherited

modulo(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this % any in JavaScript.

multiply(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this * any in JavaScript.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notEquals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this != any in JavaScript.

off([String eventType, JSFunction callback, JSObject? context]) → void

Detaches a callback previously attached with on().

inherited

on(String eventType, JSFunction callback, [JSObject? cancelCallbackOrContext, JSObject? context]) → JSFunction

Listens for data changes at a particular location.

inherited

once(String eventType, [JSFunction successCallback, JSObject? failureCallbackOrContext, JSObject? context]) → JSPromise<DataSnapshot>

Listens for exactly one event of the specified event type, and then stops listening.

inherited

onDisconnect() → OnDisconnect

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

or(JSAny? any) → JSAny?

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this || any in JavaScript.

orderByChild(String path) → Query

Generates a new Query object ordered by the specified child key.

inherited

orderByKey() → Query

Generates a new Query object ordered by key.

inherited

orderByPriority() → Query

Generates a new Query object ordered by priority.

inherited

orderByValue() → Query

Generates a new Query object ordered by value.

inherited

push([JSAny? value, JSFunction onComplete]) → JSPromise<Reference>

Generates a new child location using a unique key and returns its Reference.

remove([JSFunction onComplete]) → JSPromise<JSAny?>

Removes the data at this Database location.

set(JSAny? value, [JSFunction onComplete]) → JSPromise<JSAny?>

Writes data to this Database location.

setPriority(JSAny? priority, [JSFunction onComplete]) → JSPromise<JSAny?>

Sets a priority for the data at this Database location.

setProperty(JSAny property, JSAny? value) → void

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Write the value of property key property of this JSObject.

setWithPriority(JSAny? newVal, JSAny? newPriority, [JSFunction onComplete]) → JSPromise<JSAny?>

Writes data the Database location. Like set() but also specifies the priority for that data.

startAfter(JSAny? value, [String key]) → Query

Creates a Query with the specified starting point (exclusive).

inherited

startAt(JSAny? value, [String key]) → Query

Creates a Query with the specified starting point.

inherited

strictEquals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this === any in JavaScript.

strictNotEquals(JSAny? any) → JSBoolean

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this !== any in JavaScript.

subtract(JSAny? any) → JSAny

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this - any in JavaScript.

toJson() → JSObject

Returns a JSON-serializable representation of this object.

inherited

toJson() → Map<String, dynamic>

Available on JSAny, provided by the FirebaseJsInteropJSAnyExtension extension

Convert a JSAny to a Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

transaction(JSFunction transactionUpdate, [JSFunction onComplete, bool applyLocally]) → JSPromise<TransactionResult>

Atomically modifies the data at this location.

typeofEquals(String typeString) → bool

Available on JSAny?, provided by the JSAnyUtilityExtension extension

Whether the result of typeof on this JSAny? is typeString.

unsignedRightShift(JSAny? any) → JSNumber

Available on JSAny?, provided by the JSAnyOperatorExtension extension

The result of this >>> any in JavaScript.

update(JSObject values, [JSFunction onComplete]) → JSPromise<JSAny?>

Writes multiple values to the Database at once.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](String property) → JSAny?

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Shorthand helper for getProperty to get the value of the property key property of this JSObject, but takes a Dart value.

operator []=(String property, JSAny? value) → void

Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension

Shorthand helper for setProperty to write the value of the property key property of this JSObject, but takes a Dart value.