DocumentReference<T extends Object?> class

Represents a reference to a specific document.

Parameters:

Returns: An instance of DocumentReference.

Example:

var docRef = oracledb.doc('users/user1');

Implementers

Constructors

DocumentReference({required QueryHelper helper, required FusabaseOracledb oracledb, required String path, dynamic parent_})

fromConverter ↔ dynamic: getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
id → String: Gets the ID of the document.
no setter
oracledb → FusabaseOracledb: Gets the FusabaseOracledb instance.
no setter
parent → CollectionReference<T>: Gets the parent collection reference.
no setter
path → String: Gets the path of the document.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
toConverter ↔ dynamic: getter/setter pair
type ↔ String: getter/setter pair

collection(String collectionPath) → CollectionReference<Map<String, dynamic>>: Gets a CollectionReference for the nested collection.
delete([dynamic transObj]) → Future<void>: Deletes the document.
get([GetOptions? options, dynamic transObj]) → Future<DocumentSnapshot<T>>: Gets the document snapshot.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
set(T data, [SetOptions? options, dynamic transObj]) → Future<void>: Sets the data for the document, optionally merging.
snapshots({bool includeMetadataChanges = false, ListenSource source = ListenSource.defaultSource}) → Stream<DocumentSnapshot<T>>: Returns a stream of snapshots for the document.
toString() → String: A string representation of this object.
inherited
update(Map<Object, Object?> data, [dynamic transObj]) → Future<void>: Updates fields in the document.
withConverter<R>({required FromOracledb<R> fromOracledb, required ToOracledb<R> toOracledb}) → DocumentReference<R>: Applies converters to the document reference.