Document<T> class

Implemented types

• StoreReference

Implementers

• ObservableDocument

Constructors

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

Properties

dependenciesBuilder → DependenciesBuilder<T>?

final

fromJson → FromJson<T>?

final

hashCode → int

The hash code for this object.

no setter, override

id → String

final

parent → String

final

path → String

no setter, override

persistorSettings ↔ DocumentPersistorSettings?

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

toJson → ToJson<T>?

final

Methods

create(T data, {bool broadcast = true, bool persist = true}) → DocumentSnapshot<T>

createOrUpdate(T data, {bool broadcast = true, 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 = true}) → DocumentSnapshot<T>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

observe({bool multicast = false}) → ObservableDocument<T>

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>