DocumentReference class

DocumentReference Firestore veritabanındaki bir belge konumunu ifade eder ve konumu yazmak, okumak veya dinlemek için kullanılabilir. Başvurulan konumdaki belge mevcut olabilir veya olmayabilir.

İmza:

export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Özellikler

Mülk	Değiştiriciler	Tip	Tanım
dönüştürücü		FirestoreDataConverter <AppModelType, DbModelType> | hükümsüz	Sağlanırsa bu örnekle ilişkili FirestoreDataConverter .
itfaiye deposu		Yangın deposu	Belgenin bulunduğu Firestore örneği. Bu, örneğin işlemleri gerçekleştirmek için kullanışlıdır.
İD		sicim	Belgenin koleksiyonundaki tanımlayıcısı.
ebeveyn		KoleksiyonReferans <AppModelType, DbModelType>	Bu DocumentReference ait olduğu koleksiyon.
yol		sicim	Başvurulan belgenin yolunu temsil eden bir dize (veritabanı köküne göre).
tip		(bildirilmedi)	Bu Firestore referansının türü.

Yöntemler

Yöntem	Değiştiriciler	Tanım
Dönüştürücü ile(dönüştürücü)		Bu DocumentReference özel bir veri dönüştürücü uygulayarak, Firestore ile kendi özel model nesnelerinizi kullanmanıza olanak tanır. setDoc() öğesini çağırdığınızda , getDoc() , vb. döndürülen DocumentReference örneğiyle, sağlanan dönüştürücü NewDbModelType türündeki Firestore verileri ile özel türünüz NewAppModelType arasında dönüşüm gerçekleştirir.
Dönüştürücü ile(dönüştürücü)		Geçerli dönüştürücüyü kaldırır.

DocumentReference.converter

Sağlanırsa bu örnekle ilişkili FirestoreDataConverter .

İmza:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

DocumentReference.firestore

Belgenin bulunduğu Firestore örneği. Bu, örneğin işlemleri gerçekleştirmek için kullanışlıdır.

İmza:

readonly firestore: Firestore;

DocumentReference.id

Belgenin koleksiyonundaki tanımlayıcısı.

İmza:

get id(): string;

DocumentReference.parent

Bu DocumentReference ait olduğu koleksiyon.

İmza:

get parent(): CollectionReference<AppModelType, DbModelType>;

DocumentReference.path

Başvurulan belgenin yolunu temsil eden bir dize (veritabanı köküne göre).

İmza:

get path(): string;

DocumentReference.type

Bu Firestore referansının türü.

İmza:

readonly type = "document";

DocumentReference.withConverter()

Bu DocumentReference özel bir veri dönüştürücü uygular Firestore ile kendi özel model nesnelerinizi kullanmanıza olanak tanır. setDoc() öğesini çağırdığınızda , getDoc() , vb. döndürülen DocumentReference örneğiyle birlikte sağlanan dönüştürücü, NewDbModelType türündeki Firestore verileri ile özel türünüz NewAppModelType arasındaki dönüştürmeyi gerçekleştirir. .

İmza:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;

Parametreler

Parametre	Tip	Tanım
dönüştürücü	FirestoreDataConverter <YeniUygulamaModelTürü, YeniDbModelTürü>	Nesneleri Firestore'a ve Firestore'dan dönüştürür.

İadeler:

BelgeReferansı <YeniUygulamaModelTürü, YeniDbModelTürü>

Sağlanan dönüştürücüyü kullanan bir DocumentReference .

DocumentReference.withConverter()

Geçerli dönüştürücüyü kaldırır.

İmza:

withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;

Parametreler

Parametre	Tip	Tanım
dönüştürücü	hükümsüz	null geçerli dönüştürücüyü kaldırır.

İadeler:

BelgeReferansı < BelgeVerileri , BelgeVerileri >

Dönüştürücü kullanmayan bir DocumentReference<DocumentData, DocumentData> .