FindItemsResults<TItem extends Item> class
Represents the results of an item search operation.
- Implemented types
-
- Mixed-in types
-
Properties
-
first
→ TItem
-
The first element.
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
HighlightTerms
→ List<HighlightTerm>
-
Gets a collection containing the highlight terms that were found by the search operation.
no setter
-
highlightTerms
↔ List<HighlightTerm>
-
getter/setter pair
-
isEmpty
→ bool
-
Whether this collection has no elements.
no setterinherited
-
isNotEmpty
→ bool
-
Whether this collection has at least one element.
no setterinherited
-
Items
→ List<TItem>
-
Gets a collection containing the items that were found by the search operation.
no setter
-
items
↔ List<TItem>
-
getter/setter pair
-
iterator
→ Iterator<TItem>
-
A new
Iterator that allows iterating the elements of this Iterable.
no setteroverride
-
last
→ TItem
-
The last element.
no setterinherited
-
length
→ int
-
The number of elements in this Iterable.
no setterinherited
-
MoreAvailable
↔ bool
-
Gets a value indicating whether more items matching the search criteria
are available in the searched folder.
getter/setter pair
-
moreAvailable
↔ bool
-
getter/setter pair
-
NextPageOffset
↔ int?
-
Gets the offset that should be used with ItemView to retrieve the next page of items in a FindItems operation.
getter/setter pair
-
nextPageOffset
↔ int?
-
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
single
→ TItem
-
Checks that this iterable has only one element, and returns that element.
no setterinherited
-
TotalCount
↔ int?
-
Gets the total number of items matching the search criteria available in the searched folder.
getter/setter pair
-
totalCount
↔ int?
-
getter/setter pair
Methods
-
any(bool test(TItem 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)
→ TItem
-
Returns the
indexth element.
inherited
-
every(bool test(TItem element))
→ bool
-
Checks whether every element of this iterable satisfies
test.
inherited
-
expand<T>(Iterable<T> toElements(TItem element))
→ Iterable<T>
-
Expands each element of this Iterable into zero or more elements.
inherited
-
firstWhere(bool test(TItem element), {TItem orElse()?})
→ TItem
-
The first element that satisfies the given predicate
test.
inherited
-
fold<T>(T initialValue, T combine(T previousValue, TItem element))
→ T
-
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(Iterable<TItem> other)
→ Iterable<TItem>
-
Creates the lazy concatenation of this iterable and
other.
inherited
-
forEach(void action(TItem 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(TItem element), {TItem orElse()?})
→ TItem
-
The last element that satisfies the given predicate
test.
inherited
-
map<T>(T toElement(TItem 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(TItem combine(TItem value, TItem element))
→ TItem
-
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
singleWhere(bool test(TItem element), {TItem orElse()?})
→ TItem
-
The single element that satisfies
test.
inherited
-
skip(int count)
→ Iterable<TItem>
-
Creates an Iterable that provides all but the first
count elements.
inherited
-
skipWhile(bool test(TItem value))
→ Iterable<TItem>
-
Creates an
Iterable that skips leading elements while test is satisfied.
inherited
-
take(int count)
→ Iterable<TItem>
-
Creates a lazy iterable of the
count first elements of this iterable.
inherited
-
takeWhile(bool test(TItem value))
→ Iterable<TItem>
-
Creates a lazy iterable of the leading elements satisfying
test.
inherited
-
toList({bool growable = true})
→ List<TItem>
-
Creates a List containing the elements of this Iterable.
inherited
-
toSet()
→ Set<TItem>
-
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(TItem element))
→ Iterable<TItem>
-
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
