المهام
وظيفة | وصف |
---|---|
onDocumentCreated(مستند، معالج) | معالج الأحداث الذي يتم تشغيله عند إنشاء مستند في Firestore. |
onDocumentCreated(الخيارات، المعالج) | معالج الأحداث الذي يتم تشغيله عند إنشاء مستند في Firestore. |
onDocumentDeleted (المستند، المعالج) | معالج الأحداث الذي يتم تشغيله عند حذف مستند في Firestore. |
onDocumentDeleted(الخيارات، المعالج) | معالج الأحداث الذي يتم تشغيله عند حذف مستند في Firestore. |
onDocumentUpdated(مستند، معالج) | معالج الأحداث الذي يتم تشغيله عند تحديث مستند في Firestore. |
onDocumentUpdated(الخيارات، المعالج) | معالج الأحداث الذي يتم تشغيله عند تحديث مستند في Firestore. |
onDocumentWritten (مستند، معالج) | معالج الأحداث الذي يتم تشغيله عند إنشاء مستند أو تحديثه أو حذفه في Firestore. |
onDocumentWritten (الخيارات، المعالج) | معالج الأحداث الذي يتم تشغيله عند إنشاء مستند أو تحديثه أو حذفه في Firestore. |
الطبقات
فصل | وصف |
---|---|
يتغير | واجهة Cloud Functions للأحداث التي تغير حالتها، مثل Realtime Database أو Cloud Firestore onWrite و onUpdate . لمزيد من المعلومات حول التنسيق المستخدم لإنشاء كائنات Change ، راجع أدناه. |
واجهات
واجهه المستخدم | وصف |
---|---|
خيارات المستند | تقوم DocumentOptions بتوسيع EventHandlerOptions مع المستند المقدم وقاعدة البيانات الاختيارية ومساحة الاسم. |
FirestoreEvent | CloudEvent الذي يحتوي على DocumentSnapshot أو تغيير |
اكتب الأسماء المستعارة
اكتب الاسم المستعار | وصف |
---|---|
DocumentSnapshot | لقطة من مستند Firestore |
QueryDocumentSnapshot | لقطة من مستند استعلام Firestore |
firestore.onDocumentCreated()
معالج الأحداث الذي يتم تشغيله عند إنشاء مستند في Firestore.
إمضاء:
export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
وثيقة | وثيقة | مسار مستند Firestore الذي سيتم تشغيله. |
معالج | (الحدث: FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يتم فيها إنشاء Firestore. |
عائدات:
وظيفة السحابة < FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentCreated()
معالج الأحداث الذي يتم تشغيله عند إنشاء مستند في Firestore.
إمضاء:
export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
يختار | خيارات المستند <المستند> | الخيارات التي يمكن ضبطها على وظيفة معالجة الأحداث الفردية. |
معالج | (الحدث: FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يتم فيها إنشاء Firestore. |
عائدات:
وظيفة السحابة < FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentDeleted()
معالج الأحداث الذي يتم تشغيله عند حذف مستند في Firestore.
إمضاء:
export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
وثيقة | وثيقة | مسار مستند Firestore الذي سيتم تشغيله. |
معالج | (الحدث: FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يتم فيها حذف Firestore. |
عائدات:
وظيفة السحابة < FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentDeleted()
معالج الأحداث الذي يتم تشغيله عند حذف مستند في Firestore.
إمضاء:
export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
يختار | خيارات المستند <المستند> | الخيارات التي يمكن ضبطها على وظيفة معالجة الأحداث الفردية. |
معالج | (الحدث: FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يتم فيها حذف Firestore. |
عائدات:
وظيفة السحابة < FirestoreEvent < QueryDocumentSnapshot | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentUpdated()
معالج الأحداث الذي يتم تشغيله عند تحديث مستند في Firestore.
إمضاء:
export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
وثيقة | وثيقة | مسار مستند Firestore الذي سيتم تشغيله. |
معالج | (الحدث: FirestoreEvent < التغيير < QueryDocumentSnapshot > | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يحدث فيها تحديث لـ Firestore. |
عائدات:
وظيفة السحابة < FirestoreEvent < التغيير < QueryDocumentSnapshot > | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentUpdated()
معالج الأحداث الذي يتم تشغيله عند تحديث مستند في Firestore.
إمضاء:
export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
يختار | خيارات المستند <المستند> | الخيارات التي يمكن ضبطها على وظيفة معالجة الأحداث الفردية. |
معالج | (الحدث: FirestoreEvent < التغيير < QueryDocumentSnapshot > | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يحدث فيها تحديث لـ Firestore. |
عائدات:
وظيفة السحابة < FirestoreEvent < التغيير < QueryDocumentSnapshot > | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentWritten()
معالج الأحداث الذي يتم تشغيله عند إنشاء مستند أو تحديثه أو حذفه في Firestore.
إمضاء:
export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
وثيقة | وثيقة | مسار مستند Firestore الذي سيتم تشغيله. |
معالج | (الحدث: FirestoreEvent < التغيير < لقطة الوثيقة > | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يتم فيها إنشاء Firestore أو تحديثه أو حذفه. |
عائدات:
وظيفة السحابة < FirestoreEvent < التغيير < لقطة الوثيقة > | غير محدد، ParamsOf <المستند>>>
firestore.onDocumentWritten()
معالج الأحداث الذي يتم تشغيله عند إنشاء مستند أو تحديثه أو حذفه في Firestore.
إمضاء:
export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
حدود
معامل | يكتب | وصف |
---|---|---|
يختار | خيارات المستند <المستند> | الخيارات التي يمكن ضبطها على وظيفة معالجة الأحداث الفردية. |
معالج | (الحدث: FirestoreEvent < التغيير < لقطة الوثيقة > | غير محدد، ParamsOf <المستند>>) => أي | وعد<أي> | معالج الأحداث الذي يتم تشغيله في كل مرة يتم فيها إنشاء Firestore أو تحديثه أو حذفه. |
عائدات:
وظيفة السحابة < FirestoreEvent < التغيير < لقطة الوثيقة > | غير محدد، ParamsOf <المستند>>>
firestore.DocumentSnapshot
لقطة من مستند Firestore
إمضاء:
export type DocumentSnapshot = firestore.DocumentSnapshot;
firestore.QueryDocumentSnapshot
لقطة من مستند استعلام Firestore
إمضاء:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;