Document<T> class

Implemented types
Implementers

Constructors

Document(String parent, String id, {FromJson<T>? fromJson, ToJson<T>? toJson, DependenciesBuilder<T>? dependenciesBuilder, PersistorSettings? persistorSettings})

Properties

dependenciesBuilder → DependenciesBuilder<T>?
final
encrypted → bool
no setter
fromJson → FromJson<T>?
final
hashCode → int
The hash code for this object.
no setteroverride
id → String
final
parent → String
final
path → String
no setteroverride
persistorSettings ↔ PathPersistorSettings<StoreReference>?
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
toJson → ToJson<T>?
final

Methods

create(T data, {bool broadcast = true, bool persist = true}) → DocumentSnapshot<T>
createOrUpdate(T data, {bool? broadcast, bool persist = true}) → DocumentSnapshot<T>
delete() → void
dependencies() → Set<Document>?
dependents() → Set<Document>?
exists() → bool
get() → DocumentSnapshot<T>?
getSerialized() → dynamic
Returns the serialized document data.
isPersistenceEnabled() → bool
modify(ModifyFn<T> modifyFn, {bool? broadcast, bool persist = true}) → DocumentSnapshot<T>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
observe({bool multicast = false}) → ObservableDocument<T>
rebroadcast() → void
Schedules a document to be rebroadcasted, updating all listeners that are subscribed to that document.
rebuildDependencies() → void
Rebuild the document's dependencies with the dependenciesBuilder.
stream() → Stream<DocumentSnapshot<T>?>
streamChanges() → Stream<DocumentChangeSnapshot<T>>
subcollection<S>(String name, {FromJson<S>? fromJson, ToJson<S>? toJson, PersistorSettings? persistorSettings, DependenciesBuilder<S>? dependenciesBuilder}) → Collection<S>
toString() → String
A string representation of this object.
inherited
update(T data, {bool? broadcast, bool persist = true}) → DocumentSnapshot<T>

Operators

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

Static Methods

fromPath<S>(String path, {FromJson<S>? fromJson, ToJson<S>? toJson, PersistorSettings? persistorSettings, DependenciesBuilder<S>? dependenciesBuilder}) → Document<S>