ApiDynamicDocumentModel class
- Inheritance
-
- Mixed in types
-
- Available Extensions
Properties
-
deleteEndpoint
→ String
-
The endpoint to use when executing the Delete method.
no setterinherited
-
header when executing the Delete method.
no setterinherited
-
disposed
→ bool
-
True if the model is Disposed.
no setterinherited
-
endpoint
→ String
-
API endpoints.
finalinherited
-
entries
→ Iterable<MapEntry<String, dynamic>>
-
The map entries of this.
no setterinherited
-
getEndpoint
→ String
-
The endpoint to use when executing the Get method.
no setterinherited
-
header when executing the Get method.
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
hasListeners
→ bool
-
Whether any listeners are currently registered.
no setterinherited
-
API Header.
finalinherited
-
isEmpty
→ bool
-
Whether there is no key/value pair in the map.
no setterinherited
-
isNotEmpty
→ bool
-
Whether there is at least one key/value pair in the map.
no setterinherited
-
keys
→ Iterable<String>
-
The keys of this.
no setterinherited
-
length
→ int
-
The number of key/value pairs in the map.
no setterinherited
-
loaded
→ bool
-
It becomes
true
after loadOnce is executed.
no setterinherited
-
loading
→ Future<void>?
-
Returns itself after the load finishes.
no setterinherited
-
notifyOnChangeMap
→ bool
-
If this value is
true
,
Notify changes when there are changes in the map itself using map-specific methods.
no setteroverride
-
notifyOnChangeValue
→ bool
-
If this value is
true
,
the change will be notified when value itself is changed.
no setterinherited
-
postEndpoint
→ String
-
The endpoint to use when executing the Post method.
no setterinherited
-
header when executing the Post method.
no setterinherited
-
putEndpoint
→ String
-
The endpoint to use when executing the Put method.
no setterinherited
-
header when executing the Put method.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
saving
→ Future<void>?
-
Returns itself after the save/delete finishes.
no setterinherited
-
value
↔ DynamicMap
-
The current value stored in this notifier.
getter/setter pairinherited
-
values
→ Iterable
-
The values of this.
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
-
addListener(VoidCallback listener)
→ void
-
Register a closure to be called when the object changes.
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
-
delete()
→ Future<void>
-
Deletes the document.
inherited
-
deleteRequest()
→ Future<void>
-
The actual deleting process is done from the API when it is deleted.
inherited
-
dependOn(Listenable listenable, [Map<String, dynamic> filter(Map<String, dynamic> origin)?])
→ void
-
Sends a notification to itself when the target
listenable
is updated.
inherited
-
dispose()
→ void
-
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener and removeListener will throw after the object is
disposed).
inherited
-
fetch([bool listen = true])
→ Future<void>
-
Provides the best data acquisition method to implement during screen build.
inherited
-
filterOnLoad(DynamicMap loaded)
→ DynamicMap
-
You can filter the loaded content when it is loaded.
inherited
-
filterOnSave(DynamicMap save)
→ DynamicMap
-
You can filter the saving content when it is saving.
inherited
-
forEach(void action(String key, dynamic value))
→ void
-
Applies
action
to each key/value pair of the map.
inherited
-
fromMap(DynamicMap map)
→ DynamicMap
-
Creates a specific object from a given
map
.
override
-
fromResponse(String json)
→ DynamicMap
-
Callback for converting to a map of objects for a response.
inherited
-
initState()
→ void
-
The method to be executed when initialization is performed.
inherited
-
load()
→ Future<void>
-
Retrieves data and updates the data in the model.
inherited
-
loadOnce()
→ Future<void>
-
If the data is empty, load is performed only once.
inherited
-
loadRequest()
→ Future<void>
-
The actual loading process is done from the API when it is loaded.
inherited
-
map<K2, V2>(MapEntry<K2, V2> convert(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
-
notifyListeners()
→ void
-
Call all the registered listeners.
inherited
-
onCatchResponse(dynamic response)
→ void
-
Callback to catch what to do with the response.
inherited
-
onDelete()
→ Future<void>
-
Callback before the delete has been done.
inherited
-
onDidDelete()
→ Future<void>
-
Callback after the delete has been done.
inherited
-
onDidLoad()
→ Future<void>
-
Callback after the load has been done.
inherited
-
onDidSave()
→ Future<void>
-
Callback after the save has been done.
inherited
-
onLoad()
→ Future<void>
-
Callback before the load has been done.
inherited
-
onSave()
→ Future<void>
-
Callback before the save has been done.
inherited
-
putIfAbsent(String key, dynamic ifAbsent())
→ dynamic
-
Look up the value of
key
, or add a new entry if it isn't there.
inherited
-
reload()
→ Future<void>
-
Reload data and updates the data in the model.
inherited
-
remove(Object? key)
→ dynamic
-
Removes
key
and its associated value, if present, from the map.
inherited
-
removeListener(VoidCallback listener)
→ void
-
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
removeWhere(bool test(String key, dynamic value))
→ void
-
Removes all entries of this map that satisfy the given
test
.
inherited
-
save()
→ Future<void>
-
Data stored in the model is stored in a database external to the app that is tied to the model.
inherited
-
saveRequest()
→ Future<void>
-
The actual saving process is done from the API when it is saved.
inherited
-
toMap(DynamicMap value)
→ DynamicMap
-
Creates a DynamicMap from its own
value
.
override
-
toNotifier<V>(V converter(DynamicMap value))
→ ValueNotifier<V>
-
Generates a value notifier.
inherited
-
toRequest(DynamicMap map)
→ dynamic
-
Callback for converting internal map data to request data.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
transaction()
→ DocumentTransactionBuilder
-
Generate a Transaction for this document.
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