DocumentReference class

يشير DocumentReference إلى موقع مستند في قاعدة بيانات Firestore ويمكن استخدامه لكتابة الموقع الجغرافي أو قراءته أو الاستماع إليه. قد يكون المستند متوفرًا في الموقع الجغرافي المشار إليه أو قد لا يكون متوفرًا.

Signature:

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

أماكن إقامة

الطُرق

DocumentReference.conversioner

إنّ FirestoreDataConverter المرتبط بهذا المثيل، في حال توفّره.

Signature:

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

DocumentReference.firestore

مثيل Firestore الذي يظهر فيه المستند ويُعدّ هذا الإجراء مفيدًا لإجراء المعاملات على سبيل المثال.

Signature:

readonly firestore: Firestore;

DocumentReference.id

معرّف المستند ضمن المجموعة الخاصة به

Signature:

get id(): string;

DocumentReference.parent

المجموعة التي ينتمي إليها هذا DocumentReference.

Signature:

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

DocumentReference.path

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

Signature:

get path(): string;

DocumentReference.type

نوع مرجع Firestore هذا

Signature:

readonly type = "document";

DocumentReference.withConverter()

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

Signature:

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

المَعلمات

المرتجعات:

DocumentReference<NewAppModelType, NewDbModelType>

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

DocumentReference.withConverter()

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

Signature:

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

المَعلمات

المرتجعات:

DocumentReference<DocumentData، وDocumentData>

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