CollectionReference class

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

Signature:

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

للتوسيع: Query<AppModelType, DbModelType>

أماكن إقامة

الطُرق

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

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

Signature:

get id(): string;

GroupReference.parent

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

Signature:

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

GroupReference.path

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

Signature:

get path(): string;

GroupReference.type

نوع مرجع Firestore هذا

Signature:

readonly type = "collection";

GroupReference.withConverter()

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

Signature:

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

المَعلمات

المرتجعات:

CollectionReference <NewAppModelType, NewDbModelType>

CollectionReference يستخدِم محوّل التعريف المقدَّم.

GroupReference.withConverter()

إزالة المحوّل الحالي.

Signature:

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

المَعلمات

المرتجعات:

CollectionReference<DocumentData، وDocumentData>

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