A collection representing the set of active subscriptions for a Realm instance.
This is used in combination with FlexibleSyncConfiguration to declare the set of queries you want to synchronize with the server. You can access and read the subscription set freely, but mutating it must happen in an update block.
Any changes to the subscription set will be persisted locally and be available the next time the application starts up - i.e. it's not necessary to subscribe for the same query every time. Updating the subscription set can be done while offline, and only the latest update will be sent to the server whenever connectivity is restored.
It is strongly recommended that you batch updates as much as possible and request the dataset your application needs upfront. Updating the set of active subscriptions for a Realm is an expensive operation server-side, even if there's very little data that needs downloading.
- Mixed-in types
- Implementers
Properties
- error → Exception?
-
Returns the error if the subscription set is in the SubscriptionSetState.error state.
no setter
- first → Subscription
-
The first element.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
-
iterator
→ Iterator<
Subscription> -
A new
Iteratorthat allows iterating the elements of thisIterable.no setteroverride - last → Subscription
-
The last element.
no setterinherited
- length → int
-
The number of elements in this Iterable.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- single → Subscription
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
- state → SubscriptionSetState
-
Gets the state of the subscription set.
no setter
- version → int
-
Gets the version of the subscription set.
no setter
Methods
-
any(
bool test(Subscription element)) → bool -
Checks whether any element of this iterable satisfies
test.inherited -
cast<
R> () → Iterable< R> -
A view of this iterable as an iterable of
Rinstances.inherited -
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element.inherited -
elementAt(
int index) → Subscription -
Returns the
indexth element.override -
every(
bool test(Subscription element)) → bool -
Checks whether every element of this iterable satisfies
test.inherited -
expand<
T> (Iterable< T> toElements(Subscription element)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
find<
T extends RealmObject> (RealmResults< T> query) → Subscription? - Finds an existing Subscription in this set by its query
-
findByName(
String name) → Subscription? - Finds an existing Subscription in this set by name.
-
firstWhere(
bool test(Subscription element), {Subscription orElse()?}) → Subscription -
The first element that satisfies the given predicate
test.inherited -
fold<
T> (T initialValue, T combine(T previousValue, Subscription element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< Subscription> other) → Iterable<Subscription> -
Creates the lazy concatenation of this iterable and
other.inherited -
forEach(
void action(Subscription element)) → void -
Invokes
actionon each element of this iterable in iteration order.inherited -
join(
[String separator = ""]) → String -
Converts each element to a String and concatenates the strings.
inherited
-
lastWhere(
bool test(Subscription element), {Subscription orElse()?}) → Subscription -
The last element that satisfies the given predicate
test.inherited -
map<
T> (T toElement(Subscription 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
-
reduce(
Subscription combine(Subscription value, Subscription element)) → Subscription -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
singleWhere(
bool test(Subscription element), {Subscription orElse()?}) → Subscription -
The single element that satisfies
test.inherited -
skip(
int count) → Iterable< Subscription> -
Creates an Iterable that provides all but the first
countelements.inherited -
skipWhile(
bool test(Subscription value)) → Iterable< Subscription> -
Creates an
Iterablethat skips leading elements whiletestis satisfied.inherited -
take(
int count) → Iterable< Subscription> -
Creates a lazy iterable of the
countfirst elements of this iterable.inherited -
takeWhile(
bool test(Subscription value)) → Iterable< Subscription> -
Creates a lazy iterable of the leading elements satisfying
test.inherited -
toList(
{bool growable = true}) → List< Subscription> -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< Subscription> -
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 -
update(
void action(MutableSubscriptionSet mutableSubscriptions)) → void - Updates the subscription set and send the request to the server in the background.
-
waitForSynchronization(
[CancellationToken? cancellationToken]) → Future< void> - Waits for the server to acknowledge the subscription set and return the matching objects.
-
where(
bool test(Subscription element)) → Iterable< Subscription> -
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) → Subscription - Gets the Subscription at the specified index in the set.