Fields class

Query parameters defining Sparse Fieldsets @see https://jsonapi.org/format/#fetching-sparse-fieldsets

Mixed-in types

• MapMixin<String, Iterable<String>>

Constructors

Fields([Map<String, Iterable<String>> fields = const {}])

The fields argument maps the resource type to a list of fields.

Properties

asQueryParameters → Map<String, String>

Converts to a map of query parameters

no setter

entries → Iterable<MapEntry<String, Iterable<String>>>

The map entries of this Map.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isEmpty → bool

Whether there is no key/value pair in the map.

no setter, inherited

isNotEmpty → bool

Whether there is at least one key/value pair in the map.

no setter, inherited

keys → Iterable<String>

The keys of this Map.

no setter, override

length → int

The number of key/value pairs in the map.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

values → Iterable<Iterable<String>>

The values of this Map.

no setter, inherited

Methods

addAll(Map<String, Iterable<String>> other) → void

Adds all key/value pairs of other to this map.

inherited

addEntries(Iterable<MapEntry<String, Iterable<String>>> 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.

override

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 action(String key, Iterable<String> value)) → void

Applies action to each key/value pair of the map.

inherited

map<K2, V2>(MapEntry<K2, V2> transform(String key, Iterable<String> 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

putIfAbsent(String key, Iterable<String> ifAbsent()) → Iterable<String>

Look up the value of key, or add a new entry if it isn't there.

inherited

remove(Object? key) → Iterable<String>?

Removes key and its associated value, if present, from the map.

override

removeWhere(bool test(String key, Iterable<String> value)) → void

Removes all entries of this map that satisfy the given test.

inherited

toString() → String

A string representation of this object.

inherited

update(String key, Iterable<String> update(Iterable<String> value), {Iterable<String> ifAbsent()?}) → Iterable<String>

Updates the value for the provided key.

inherited

updateAll(Iterable<String> update(String key, Iterable<String> value)) → void

Updates all values.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](Object? key) → Iterable<String>?

The value for the given key, or null if key is not in the map.

override

operator []=(String key, Iterable<String> value) → void

Associates the key with the given value.

override

Static Methods

fromUri(Uri uri) → Fields

Extracts the requested fields from the uri.