CollectionReference class

يمكن استخدام كائن CollectionReference لإضافة المستندات والحصول على مراجع المستندات والاستعلام عن المستندات (باستخدام query() ).

إمضاء:

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

يمتد: الاستعلام <AppModelType، DbModelType>

ملكيات

طُرق

CollectionReference.id

معرف المجموعة.

إمضاء:

get id(): string;

CollectionReference.parent

مرجع إلى DocumentReference الذي يحتوي عليه إذا كانت هذه مجموعة فرعية. إذا لم تكن هذه مجموعة فرعية، فسيكون المرجع خاليًا.

إمضاء:

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

CollectionReference.path

سلسلة تمثل مسار المجموعة المشار إليها (بالنسبة إلى جذر قاعدة البيانات).

إمضاء:

get path(): string;

CollectionReference.type

نوع مرجع Firestore هذا.

إمضاء:

readonly type = "collection";

CollectionReference.withConverter()

يطبق محول بيانات مخصص على CollectionReference ، مما يسمح لك باستخدام كائنات النموذج المخصصة الخاصة بك مع Firestore. عند استدعاء addDoc() ‎ مع مثيل CollectionReference الذي تم إرجاعه، سيقوم المحول المقدم بالتحويل بين بيانات Firestore من النوع NewDbModelType والنوع المخصص NewAppModelType .

إمضاء:

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

حدود

عائدات:

مرجع المجموعة <NewAppModelType، NewDbModelType>

مرجع CollectionReference يستخدم المحول المتوفر.

CollectionReference.withConverter()

يزيل المحول الحالي.

إمضاء:

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

حدود

عائدات:

مرجع المجموعة < بيانات الوثيقة ، بيانات الوثيقة >

CollectionReference<DocumentData, DocumentData> الذي لا يستخدم محولاً.