JSONPaging class abstract

Generic representation of a paging result in JSON.

Inheritance

Constructors

JSONPaging(Map<String, dynamic> json)

Properties

currentPage → int
Current page index, starting from 0.
no setter
elements → List
Elements in this page.
no setter
elementsEntryKey → String
The json key for elements.
no setter
elementsLength → int
Current page elements length.
no setter
elementsOffset → int
The offset of elements for the request.
no setter
elementsPerPage → int
Number of elements used for paging.
no setter
entries → Iterable<MapEntry<String, dynamic>>
The map entries of this Map.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Whether there is no key/value pair in the map.
no setterinherited
isFirstPage → bool
Returns true if this is the first page.
no setter
isLastPage → bool
Returns true if this is the last page.
no setter
isNotEmpty → bool
Whether there is at least one key/value pair in the map.
no setterinherited
json → Map<String, dynamic>
no setter
keys → Iterable<String>
The keys of this Map.
no setterinherited
length → int
The number of key/value pairs in the map.
no setterinherited
mainMap → Map<String, dynamic>
no setterinherited
needsPaging → bool
If needs a paging controller.
no setter
nextPage → int
Next page index.
no setter
pagingFormat → String
Paging implementation format/name.
no setter
pagingRequester ↔ PagingRequester?
Requesting Function that is able to make new requests to a specific page. See PagingRequester.
getter/setter pair
previousPage → int
The index of the previous page.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
totalElements → int?
Total elements of request.
no setter
totalPages → int?
Total number of pages.
no setter
values → Iterable
The values of this Map.
no setterinherited

Methods

addAll(Map<String, dynamic> other) → void
Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry<String, dynamic>> newEntries) → void
Adds all key/value pairs of newEntries to this map.
inherited
cast<RK, RV>() → Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void
Removes all entries from the map.
inherited
containsKey(Object? key) → bool
Whether this map contains the given key.
inherited
containsValue(Object? value) → bool
Whether this map contains the given value.
inherited
forEach(void f(String key, dynamic value)) → void
Applies action to each key/value pair of the map.
inherited
isOfPagingFormat(String? format) → bool
Returns true if format is the same of current pagingFormat.
map<K2, V2>(MapEntry<K2, V2> f(String key, dynamic value)) → Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pagingRequestURL(String url, int page) → String
The url for a request using url and page to build.
putIfAbsent(String key, dynamic ifAbsent()) → dynamic
Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) → dynamic
Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool predicate(String key, dynamic value)) → void
Removes all entries of this map that satisfy the given test.
inherited
requestNextPage() → Future<JSONPaging?>
Requests next page. If isLastPage returns this.
requestPage(int page) → Future<JSONPaging?>
requestPreviousPage() → Future<JSONPaging?>
Requests the previous page. If isFirstPage returns this.
toString() → String
A string representation of this object.
inherited
update(String key, dynamic update(dynamic value), {dynamic ifAbsent()?}) → dynamic
Updates the value for the provided key.
inherited
updateAll(dynamic update(String key, dynamic value)) → void
Updates all values.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited
operator [](Object? key) → dynamic
The value for the given key, or null if key is not in the map.
inherited
operator []=(String key, dynamic value) → void
Associates the key with the given value.
inherited

Static Methods

from(Object? json) → JSONPaging?
registerPagingFormat(PagingFormatMatcher matcher, PagingFormatInstantiator instantiator) → void