DocumentReference class

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

إمضاء:

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

ملكيات

ملكية	الصفات التعريفية	يكتب	وصف
محول		FirestoreDataConverter <AppModelType، DbModelType> | باطل	إذا تم توفيره، فإن FirestoreDataConverter مرتبط بهذا المثيل.
firestore		فايرستور	مثيل Firestore الموجود فيه المستند. وهذا مفيد لتنفيذ المعاملات، على سبيل المثال.
بطاقة تعريف		خيط	معرف المستند ضمن مجموعته.
الأبوين		مرجع المجموعة <AppModelType، DbModelType>	المجموعة التي ينتمي إليها DocumentReference .
طريق		خيط	سلسلة تمثل مسار المستند المشار إليه (بالنسبة إلى جذر قاعدة البيانات).
يكتب		(غير معلن)	نوع مرجع Firestore هذا.

طُرق

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

DocumentReference.converter

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

إمضاء:

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

DocumentReference.firestore

مثيل Firestore الموجود فيه المستند. وهذا مفيد لتنفيذ المعاملات، على سبيل المثال.

إمضاء:

readonly firestore: Firestore;

DocumentReference.id

معرف المستند ضمن مجموعته.

إمضاء:

get id(): string;

DocumentReference.parent

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

إمضاء:

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

DocumentReference.path

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

إمضاء:

get path(): string;

DocumentReference.type

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

إمضاء:

readonly type = "document";

DocumentReference.withConverter()

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

إمضاء:

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

حدود

معامل	يكتب	وصف
محول	FirestoreDataConverter <NewAppModelType، NewDbModelType>	تحويل الكائنات من وإلى Firestore.

عائدات:

وثيقة مرجعية <NewAppModelType، NewDbModelType>

DocumentReference يستخدم المحول المتوفر.

DocumentReference.withConverter()

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

إمضاء:

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

حدود

معامل	يكتب	وصف
محول	باطل	null يزيل المحول الحالي.

عائدات:

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

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