Sort class

Query parameters defining the sorting. @see https://jsonapi.org/format/#fetching-sorting

Implemented types
Mixed-in types

Constructors

Sort([Iterable<String> fields = const []])
The fields arguments is the list of sorting criteria.

Properties

first → SortField
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<SortField>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
last → SortField
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 → SortField
Checks that this iterable has only one element, and returns that element.
no setterinherited

Methods

any(bool test(SortField 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 R instances.
inherited
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → SortField
Returns the indexth element.
inherited
every(bool test(SortField element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(SortField element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(SortField element), {SortField orElse()?}) → SortField
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, SortField element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<SortField> other) → Iterable<SortField>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(SortField 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(SortField element), {SortField orElse()?}) → SortField
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(SortField 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(SortField combine(SortField value, SortField element)) → SortField
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
singleWhere(bool test(SortField element), {SortField orElse()?}) → SortField
The single element that satisfies test.
inherited
skip(int count) → Iterable<SortField>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(SortField value)) → Iterable<SortField>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) → Iterable<SortField>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(SortField value)) → Iterable<SortField>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) → List<SortField>
Creates a List containing the elements of this Iterable.
inherited
toQuery() → Map<String, List<String>>
Converts to a map of query parameters
override
toSet() → Set<SortField>
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(SortField element)) → Iterable<SortField>
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

Static Methods

fromUri(Uri uri) → Sort