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