SubCollectionModel<T extends Model> class Null safety

Inheritance

Constructors

SubCollectionModel()

Properties

collectionName String
collection name FirestoreModel use your Model name
read-onlyoverride
createdAt DateTime?
DateTime when document is created
read / writeinherited
docId String?
document id FirestoreModel will get it for your model
read / writeinherited
hashCode int
The hash code for this object.
read-onlyinherited
isUpdating bool
read / writeinherited
parentPath String?
we will fill it if model is SubCollection
read / writeinherited
path String?
A string representing the path of the referenced document (relative to the root of the database).
read / writeinherited
perPage int
default items in page
read-onlyinherited
responseBuilder ResponseBuilder<T>
model mapping to write in collection
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
subCollectionName String
read-only
toMap Map<String, dynamic>
model mapping to write in collection
read-onlyinherited
updatedAt DateTime?
DateTime when document is updated
read / writeinherited
withTimestamps bool
default true set timestamps
read-onlyinherited

Methods

all() Future<List<T?>>
To get all documents call all List
inherited
arrayRemove({required String field, required List elements, String? docId}) Future<void>
update field realtime value tells the server to remove the given elements from any array value that already exists on the server.
inherited
arrayUnion({required String field, required List elements, String? docId}) Future<void>
update field realtime value tells the server to union the given elements with any array value that already exists on the server.
inherited
bulkDelete({List<String>? docsIds, Query<Object?> query(Query<Object?> query)?}) Future<void>
delete more one document model call bulkDelete delete specific models use bulkDelete by pass docsIds FirestoreModel.use
inherited
bulkUpdate({List<String>? docsIds, required Map<String, Object?> data, Query<Object?> query(Query<Object?> query)?}) Future<void>
inherited
create({String? docId}) Future<T?>
To Write in firestore database call create method from your model like this: user.create(); if you have docId for doc: user.create(docId: 'doc_id'); return model after create
inherited
decrement({required String field, String? docId, num value = 1}) Future<void>
update field realtime value that tells the server to decrement the field’s current value by the given value.
inherited
delete({String? docId}) Future<void>
delete current model call delete user.delete(); delete specific model use delete by pass docId: FirestoreModel.use
inherited
exists(String docId) Future<bool>
check if document is exists call exists by docId bool isExists = await FirestoreModel.use
inherited
find(String docId) Future<T?>
To get document data by document id call find and pass docId User user = await FirestoreModel.use
inherited
first({Query<Object?> queryBuilder(Query<Object?> query)?}) Future<T?>
To get first result from your collection call first you can build your query like where orderBy or any query buildr methods in queryBuilder User firstUser = await FirestoreModel.use
inherited
get({Query<Object?> queryBuilder(Query<Object?> query)?, Query<Object?>? query}) Future<List<T?>?>
To get results from your collection call get you can build your query like where orderBy or any query buildr methods in queryBuilder List
inherited
getSubCollection(String subCollection, {String? docId, Query<Object?> queryBuilder(Query<Object?> query)?}) Future<List<T?>?>
inherited
increment({required String field, String? docId, num value = 1}) Future<void>
update field realtime value that tells the server to increment the field’s current value by the given value.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
paginate({int? perPage, Query<Object?> queryBuilder(Query<Object?> query)?}) Future<List<T?>>
To get results limit and load more as pagination from your collection call paginate you can build your query like where orderBy or any query buildr methods in queryBuilder you can set perPage in your call or set in your model List
inherited
remove({required String field, String? docId}) Future<void>
remove field from document
inherited
save({String? docId, SetOptions? setOptions}) Future<void>
make changes to your model and call save user.firstName = 'new firstname'; user.save()
inherited
streamAll() Stream<List<T?>>?
To stream all documents call streamAll Stream<List
inherited
streamFind(String docId) Stream<T?>
To stream document data by document id call streamFind as pass docId Stream
inherited
streamFirst({Query<Object?> queryBuilder(Query<Object?> query)?, dynamic onChange(T? dataChange)?}) Stream<T?>
To stream document data by document id call streamFind as pass docId Stream
inherited
streamGet({Query<Object?> queryBuilder(Query<Object?> query)?, Query<Object?>? query, dynamic onChange(List<T?> chnagesData)?}) Stream<List<T?>?>
To stream results from your collection call streamGet with queryBuilder Stream<List
inherited
streamPaginate({int? perPage, Query<Object?> queryBuilder(Query<Object?> query)?}) Stream<List<T?>>
To stream results from your collection call streamPaginate Stream<List
inherited
streamSubCollection(String subCollection, {String? docId, Query<Object?> queryBuilder(Query<Object?> query)?}) Stream<List<T?>?>
inherited
subCollection<S extends Model>({String? path}) → S
inherited
toString() String
A string representation of this object.
inherited
update({String? docId, required Map<String, Object?> data}) Future<void>
update specific fields in your model call update by pass data user.update(data: { "first_name": "Mohamed", "last_name": "Abdullah" }) update specific model use update by pass docId and data FirestoreModel.use
inherited

Operators

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