ModelAdapter<TDocument extends DynamicDocumentModel, TCollection extends DynamicCollectionModel<DynamicDocumentModel>> class abstract

This class is used to specify data adapters for modules.

Specify the Document class in Document, the Collection class in Collection, and the Provider for each.

ModelAdapter can switch the data when the module is used by passing it to UIMaterialApp.

Inheritance
Implementers
Annotations

Constructors

ModelAdapter()
const

Properties

email → String
You can get the Email after authentication is completed.
no setter
enabled → bool
true if Module is enabled.
finalinherited
enabledAuth → bool
Return true If authentication is enabled.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
ID of the module.
finalinherited
isAnonymously → bool
For anonymous logged in users, True.
no setter
isSignedIn → bool
True if you are signed in.
no setter
isVerified → bool
You can get the status that user email is verified after authentication is completed.
no setter
name → String
You can get the Display Name after authentication is completed.
no setter
phoneNumber → String
You can get the PhoneNumber after authentication is completed.
no setter
photoURL → String
You can get the PhotoURL after authentication is completed.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → String
Module Type.
no setterinherited
userId → String
You can get the UID after authentication is completed.
no setter

Methods

collectionProvider(String path) → ModelProvider<TCollection>
Performs the process of loading a document.
createDocument(TCollection collection, [String? id]) → TDocument
Performs the process of loading a collection.
deleteDocument(TDocument document) → Future<void>
Deletes information associated with a document.
documentProvider(String path) → ModelProvider<TDocument>
Gets the provider of the Document.
fromMap(dynamic map) → Module?
Convert the module information from DynamicMap.
inherited
loadCollection(TCollection collection, [bool once = false]) → TCollection
Performs the process of loading a collection.
loadDocument(TDocument document, [bool once = false]) → TDocument
Performs the process of loading a document.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerInEmailAndPassword({required String email, required String password}) → Future<void>
Register as a user using your email and password.
saveDocument(TDocument document) → Future<void>
Save the data in the document so that you can use it after restarting the app.
sendPasswordResetEmail({required String email}) → Future<void>
Email for password reset will be sent to the specified email.
signInAnonymously() → Future<void>
Guest login.
signInEmailAndPassword({required String email, required String password}) → Future<void>
Login using your email and password.
signOut() → Future<void>
Log out.
toMap() → dynamic
Convert the module information to DynamicMap.
inherited
toString() → String
A string representation of this object.
inherited
tryRestoreAuth() → Future<void>
Used to restore your login information.
uploadMedia(String path) → Future<String>
Upload your media.

Operators

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