RealmResults<T extends Object?> class Realm

Instances of this class are live collections and will update as new elements are either added to or deleted from the Realm that match the underlying query.

Inheritance
Mixed-in types
Available extensions

Properties

changes → Stream<RealmResultsChanges<T>>
Allows listening for changes when the contents of this collection changes.
no setter
first → T
The first element.
no setteroverride
firstOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The first element of this iterator, or null if the iterable is empty.
no setter
hashCode → int
The hash code for this object.
no setterinherited
indexed → Iterable<(int, T)>

Available on Iterable<T>, provided by the IterableExtensions extension

Pairs of elements of the indices and elements of this iterable.
no setter
isEmpty → bool
true if the Results collection is empty.
no setteroverride
isFrozen → bool
True if the entity belongs to a frozen Realm.
no setterinherited
isManaged → bool
True if the object belongs to a Realm.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
isValid → bool
Gets a value indicating whether this collection is still valid to use.
no setter
iterator → Iterator<T>
Returns a new Iterator that allows iterating the elements in this RealmResults.
no setteroverride
last → T
The last element.
no setteroverride
lastOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The last element of this iterable, or null if the iterable is empty.
no setter
length → int
The number of values in this Results collection.
no setteroverride
nonNulls → Iterable<T>

Available on Iterable<T?>, provided by the NullableIterableExtensions extension

The non-null elements of this iterable.
no setter
realm → Realm
The Realm instance this object belongs to.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → T
Checks that this iterable has only one element, and returns that element.
no setteroverride
singleOrNull → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The single element of this iterator, or null.
no setter
wait → Future<List<T>>

Available on Iterable<Future<T>>, provided by the FutureIterable extension

Waits for futures in parallel.
no setter

Methods

any(bool test(T element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
asNameMap() → Map<String, T>

Available on Iterable<T>, provided by the EnumByName extension

Creates a map from the names of enum values to the values.
byName(String name) → T

Available on Iterable<T>, provided by the EnumByName extension

Finds the enum value in this list with name name.
cast<R>() → Iterable<R>
A view of this iterable as an iterable of R instances.
inherited
changesFor([List<String>? keyPaths]) → Stream<RealmResultsChanges<T>>

Available on RealmResults<T>, provided by the RealmResultsOfObject extension

Allows listening for changes when the contents of this collection changes on one of the provided keyPaths. If keyPaths is null, default notifications will be raised (same as RealmResults.change). If keyPaths is an empty list, only notifications related to the collection itself will be raised (such as adding or removing elements).
contains(covariant T element) → bool
true if the Results collection contains the specified element.
override
elementAt(int index) → T
Returns the element of type T at the specified index.
override
elementAtOrNull(int index) → T?

Available on Iterable<T>, provided by the IterableExtensions extension

The element at position index of this iterable, or null.
every(bool test(T element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(T element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(T element), {T orElse()?}) → T
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, T element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<T> other) → Iterable<T>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(T element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
freeze() → RealmResults<T>
Creates a frozen snapshot of this query.
indexOf(covariant T element, [int start = 0]) → int
Returns the index of the first occurrence of the specified element in this collection, or -1 if the collection does not contain the element.
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(T element), {T orElse()?}) → T
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(T e)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
query(String query, [List<Object> args = const []]) → RealmResults<T>

Available on RealmResults<T>, provided by the RealmResultsOfObject extension

Returns a new RealmResults filtered according to the provided query.
reduce(T combine(T value, T element)) → T
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(T element), {T orElse()?}) → T
The single element that satisfies test.
inherited
skip(int count) → RealmResults<T>
Creates an Iterable that provides all but the first count elements.
override
skipWhile(bool test(T value)) → Iterable<T>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) → Iterable<T>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(T value)) → Iterable<T>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<T>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<T>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
Returns a string representation of (some of) the elements of this.
inherited
where(bool test(T element)) → Iterable<T>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](int index) → T
Returns the element of type T at the specified index.