CollectionReference class

Doküman eklemek, doküman başvurularını almak ve dokümanlarda sorgulama yapmak (query() ile) için CollectionReference nesnesi kullanılabilir.

İmza:

export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>

Kapsamı: Sorgu<AppModelType, DbModelType>

Özellikler

Özellik Değiştiriciler Tür Açıklama
id dize Koleksiyonun tanımlayıcısı.
parent DocumentReference<DocumentData, DocumentData> | boş Bu bir alt koleksiyonsa içeren DocumentReference öğesine referans. Bu bir alt koleksiyon değilse referans null olur.
path dize Başvuruda bulunulan koleksiyonun 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 CollectionReference öğesine özel bir veri dönüştürücü uygulayarak, Firestore ile kendi özel model nesnelerinizi kullanmanızı sağlar. Döndürülen CollectionReference örneğiyle addDoc() çağrısı yaptığınızda, 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.
withConverter(dönüştürücü) Mevcut dönüştürücüyü kaldırır.

KoleksiyonReferansı.id

Koleksiyonun tanımlayıcısı.

İmza:

get id(): string;

KoleksiyonReferansı.üst öğe

Bu bir alt koleksiyonsa içeren DocumentReference öğesine referans. Bu bir alt koleksiyon değilse referans null olur.

İmza:

get parent(): DocumentReference<DocumentData, DocumentData> | null;

KoleksiyonReferansı.yolu

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

İmza:

get path(): string;

KoleksiyonReferansı.type

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

İmza:

readonly type = "collection";

KoleksiyonReferansı.withConverter()

Bu CollectionReference 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 CollectionReference örneğiyle addDoc() çağrısı yaptığınızda, 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>): CollectionReference<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:

CollectionReference<NewAppModelType, NewDbModelType>

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

KoleksiyonReferansı.withConverter()

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

İmza:

withConverter(converter: null): CollectionReference<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:

CollectionReference<DocumentData, DocumentData>

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