يحتوي DocumentSnapshot على البيانات المقروءة من مستند موجود في قاعدة بيانات Firestore. يمكن استخراج البيانات باستخدام .data() أو .get(<field>) للحصول على حقل معين.
بالنسبة إلى DocumentSnapshot التي تشير إلى مستند غير موجود، فإن أي وصول للبيانات سيرجع "غير محدد". يمكنك استخدام الطريقة exists() للتحقق بشكل صريح من وجود المستند.
إمضاء:
export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
البنائين
| البناء | الصفات التعريفية | وصف |
|---|---|---|
| (البناء)() | إنشاء مثيل جديد لفئة DocumentSnapshot |
ملكيات
| ملكية | الصفات التعريفية | يكتب | وصف |
|---|---|---|---|
| بطاقة تعريف | خيط | خاصية DocumentSnapshot التي توفر معرف المستند. | |
| المرجع | وثيقة مرجعية <AppModelType، DbModelType> | DocumentReference للمستند المضمن في DocumentSnapshot . |
طُرق
| طريقة | الصفات التعريفية | وصف |
|---|---|---|
| بيانات() | يسترد كافة الحقول في المستند Object . يُرجع undefined إذا لم يكن المستند موجودًا. | |
| موجود () | إشارات تشير إلى ما إذا كان المستند الموجود في موقع اللقطة موجودًا أم لا. | |
| الحصول على (مسار الحقل) | يسترد الحقل المحدد بواسطة fieldPath . يُرجع undefined في حالة عدم وجود المستند أو الحقل. |
DocumentSnapshot.(المنشئ)
إنشاء مثيل جديد لفئة DocumentSnapshot
إمضاء:
protected constructor();
DocumentSnapshot.id
خاصية DocumentSnapshot التي توفر معرف المستند.
إمضاء:
get id(): string;
DocumentSnapshot.ref
DocumentReference للمستند المضمن في DocumentSnapshot .
إمضاء:
get ref(): DocumentReference<AppModelType, DbModelType>;
DocumentSnapshot.data()
يسترد كافة الحقول في المستند Object . يُرجع undefined إذا لم يكن المستند موجودًا.
إمضاء:
data(): AppModelType | undefined;
عائدات:
نوع نموذج التطبيق | غير معرف
Object يحتوي على كافة الحقول الموجودة في المستند أو undefined في حالة عدم وجود المستند.
DocumentSnapshot.exists()
إشارات تشير إلى ما إذا كان المستند الموجود في موقع اللقطة موجودًا أم لا.
إمضاء:
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
عائدات:
هذا هو QueryDocumentSnapshot <AppModelType، DbModelType>
صحيح إذا كانت الوثيقة موجودة.
DocumentSnapshot.get()
يسترد الحقل المحدد بواسطة fieldPath . يُرجع undefined في حالة عدم وجود المستند أو الحقل.
إمضاء:
get(fieldPath: string | FieldPath): any;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| this.fieldPath | سلسلة | مسار الحقل | المسار (على سبيل المثال 'foo' أو 'foo.bar') إلى حقل معين. |
عائدات:
أي
البيانات الموجودة في موقع الحقل المحدد أو غير محددة في حالة عدم وجود مثل هذا الحقل في المستند.