DocumentReference class

DocumentReference, Firestore veritabanındaki bir doküman konumunu ifade eder ve konumu yazmak, okumak veya dinlemek için kullanılabilir. Atıfta bulunulan konumdaki belge mevcut veya olmayabilir.

İmza:

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

Özellikler

Özellik Değiştiriciler Tür Açıklama
dönüşüm gerçekleştiren FirestoreDataConverter<AppModelType, DbModelType> | boş Sağlanmışsa bu örnekle ilişkilendirilen FirestoreDataConverter.
firestore Firestore Dokümanın bulunduğu Firestore örneği. Bu, örneğin işlemleri gerçekleştirirken yararlıdır.
id dize Dokümanın koleksiyonundaki tanımlayıcısı.
parent CollectionReference<AppModelType, DbModelType> Bu DocumentReference öğesinin ait olduğu koleksiyon.
path dize Başvuruda bulunulan belgenin yolunu temsil eden dize (veritabanının köküne göre).
tür (bildirilmedi) Bu Firestore referansının türü.

Yöntemler

Yöntem Değiştiriciler Açıklama
withConverter(dönüştürücü) Bu DocumentReference öğesine özel bir veri dönüştürücü uygulayarak, Firestore ile kendi özel model nesnelerinizi kullanmanızı sağlar. Döndürülen DocumentReference örneğiyle setDoc(), getDoc() vb. çağırırken sağlanan dönüştürücü, NewDbModelType türündeki Firestore verileri ile sizin özel türünüz NewAppModelType arasında dönüşüm gerçekleştirir.
withConverter(dönüştürücü) Mevcut dönüştürücüyü kaldırır.

DocumentReference.converter

Sağlanmışsa bu örnekle ilişkilendirilen FirestoreDataConverter.

İmza:

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

DocumentReference.firestore

Dokümanın bulunduğu Firestore örneği. Bu, örneğin işlemleri gerçekleştirirken yararlıdır.

İmza:

readonly firestore: Firestore;

DokümanReferansı.id

Dokümanın koleksiyonundaki tanımlayıcısı.

İmza:

get id(): string;

DokümanReferansı.üst öğe

Bu DocumentReference öğesinin ait olduğu koleksiyon.

İmza:

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

DokümanReferansı.yol

Başvuruda bulunulan belgenin yolunu temsil eden dize (veritabanının köküne göre).

İmza:

get path(): string;

DokümanReferansı.type

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

İmza:

readonly type = "document";

DocumentReference.withConverter()

Bu DocumentReference için özel bir veri dönüştürücü uygulayarak Firestore ile kendi özel model nesnelerinizi kullanmanızı sağlar. Döndürülen DocumentReference örneğiyle setDoc(), getDoc() vb. çağırırken sağlanan dönüştürücü, NewDbModelType türündeki Firestore verileri ile NewAppModelType özel türünüz arasında dönüşüm gerçekleştirir.

İmza:

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

Parametreler

Parametre Tür Açıklama
dönüşümü gerçekleştiren FirestoreDataConverter<NewAppModelType, NewDbModelType> Nesneleri Firestore'a ve Firestore'dan dönüştürür.

Şunu döndürür:

DocumentReference<NewAppModelType, NewDbModelType>

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

DocumentReference.withConverter()

Mevcut dönüştürücüyü kaldırır.

İmza:

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

Parametreler

Parametre Tür Açıklama
dönüşümü gerçekleştiren null null, mevcut dönüştürücüyü kaldırır.

Şunu döndürür:

DocumentReference<DocumentData, DocumentData>

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