ApiDocumentModel<T> class abstract

Class that can retrieve data from the RestAPI and store it as a document.

Basically, you get a Map as a response of RestAPI and use it by converting it. The data is converted using fromResponse and toRequest.

Use get in the load() method and post in the save() method as HTTP methods.

Inheritance
Implemented types
Implementers

Constructors

ApiDocumentModel(String endpoint, T initialValue)
Class that can retrieve data from the RestAPI and store it as a document.

Properties

deleteEndpoint → String
The endpoint to use when executing the Delete method.
no setter
deleteHeaders → Map<String, String>
header when executing the Delete method.
no setter
endpoint → String
API endpoints.
final
future → Future<void>?
Returns itself after the load/save finishes.
no setteroverride
getEndpoint → String
The endpoint to use when executing the Get method.
no setter
getHeaders → Map<String, String>
header when executing the Get method.
no setter
hashCode → int
The hash code for this object.
no setteroverride
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
initialMock → T?
Initial value of mock.
final
isEmpty → bool
Return true if data is empty.
no setterinherited
isNotEmpty → bool
Return true if data is not empty.
no setterinherited
loaded ↔ bool
It becomes true after loadOnce is executed.
getter/setter pairoverride-getter
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 setter
postHeaders → Map<String, String>
header when executing the Post method.
no setter
putEndpoint → String
The endpoint to use when executing the Put method.
no setter
putHeaders → Map<String, String>
header when executing the Put method.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value ↔ T
The current value stored in this notifier.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
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
filterOnLoad(dynamic loaded) → dynamic
You can filter the loaded content when it is loaded.
filterOnSave(dynamic save) → dynamic
You can filter the saving content when it is saving.
fromMap(dynamic map) → T
Creates a specific object from a given map.
inherited
fromResponse(String json) → dynamic
Callback for converting to a map of objects for a response.
initState() → void
The method to be executed when initialization is performed.
override
load() → Future<ApiDocumentModel<T>>
Retrieves data and updates the data in the model.
override
loadOnce() → Future<ApiDocumentModel<T>>
If the data is empty, load is performed only once.
override
loadRequest() → Future<void>
The actual loading process is done from the API when it is loaded.
mock(T mockData) → ApiDocumentModel<T>
Register the data for the mock.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
onCatchResponse(Response response) → void
Callback to catch what to do with the response.
onDidLoad() → Future<void>
Callback after the load has been done.
override
onDidSave() → Future<void>
Callback after the save has been done.
override
onLoad() → Future<void>
Callback before the load has been done.
override
onSave() → Future<void>
Callback before the save has been done.
override
reload() → Future<ApiDocumentModel<T>>
Reload data and updates the data in the model.
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
save() → Future<ApiDocumentModel<T>>
Data stored in the model is stored in a database external to the app that is tied to the model.
override
saveRequest() → Future<void>
The actual loading process is done from the API when it is saved.
toMap(T value) → dynamic
Creates a DynamicMap from its own value.
inherited
toNotifier<V>(V converter(T value)) → ValueNotifier<V>
Generates a value notifier.
inherited
toRequest(dynamic map) → dynamic
Callback for converting internal map data to request data.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override