Include class Null safety

Query parameter defining inclusion of related resources. @see https://jsonapi.org/format/#fetching-includes

Mixed in types
Available Extensions

Constructors

Include([Iterable<String> resources = const []])
Example:

Properties

asQueryParameters Map<String, String>
Converts to a map of query parameters
read-only
first String
Returns the first element.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
isEmpty bool
Whether this collection has no elements.
read-onlyinherited
isNotEmpty bool
Whether this collection has at least one element.
read-onlyinherited
iterator Iterator<String>
Returns a new Iterator that allows iterating the elements of this Iterable.
read-onlyoverride
last String
Returns the last element.
read-onlyinherited
length int
Returns the number of elements in this.
read-onlyoverride
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
single String
Checks that this iterable has only one element, and returns that element.
read-onlyinherited

Methods

any(bool test(String element)) bool
Checks whether any element of this iterable satisfies test.
inherited
cast<R>() Iterable<R>
Provides a view of this iterable as an iterable of R instances.
inherited
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) String
Returns the indexth element.
inherited
every(bool test(String element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(String element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(String value), {String orElse()?}) String
Returns the first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, String element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<String> other) Iterable<String>
Returns the lazy concatenation of this iterable and other.
inherited
forEach(void action(String element)) → void
Invokes action on 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(String value), {String orElse()?}) String
Returns the last element that satisfies the given predicate test.
inherited
map<T>(T toElement(String element)) Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
reduce(String combine(String value, String element)) String
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(String element), {String orElse()?}) String
Returns the single element that satisfies test.
inherited
skip(int count) Iterable<String>
Returns an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(String value)) Iterable<String>
Returns an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) Iterable<String>
Returns a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(String value)) Iterable<String>
Returns a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<String>
Creates a List containing the elements of this Iterable.
inherited
toSet() Set<String>
Creates a Set containing the same elements as this iterable.
inherited
toString() String
A string representation of this object.
inherited
where(bool test(String element)) Iterable<String>
Returns a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() Iterable<T>
Returns a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

fromUri(Uri uri) Include