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