امضا:
export declare class DocumentBuilder<Path extends string>
سازندگان
| سازنده | اصلاح کننده ها | شرح |
|---|---|---|
| (سازنده) (triggerResource، گزینه ها) | یک نمونه جدید از کلاس DocumentBuilder می سازد |
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| onCreate (هندلر) | فقط به ایجاد سند پاسخ دهید. | |
| onDelete (هندلر) | فقط به حذف اسناد پاسخ دهید. | |
| onUpdate (هندلر) | فقط به به روز رسانی اسناد پاسخ دهید. | |
| onWrite (هندلر) | به تمام نوشته‌های سند (ایجاد، به‌روزرسانی یا حذف) پاسخ دهید. |
firestore.DocumentBuilder.(سازنده)
یک نمونه جدید از کلاس DocumentBuilder می سازد
امضا:
constructor(triggerResource: () => string, options: DeploymentOptions);
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| triggerResource | () => رشته | |
| گزینه ها | DeploymentOptions |
firestore.DocumentBuilder.onCreate()
فقط به ایجاد سند پاسخ دهید.
امضا:
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (عکس فوری: QueryDocumentSnapshot ، زمینه: EventContext <ParamsOf<Path>>) => PromiseLike<any> | هر |
برمی گرداند:
CloudFunction < QueryDocumentSnapshot >
firestore.DocumentBuilder.onDelete()
فقط به حذف اسناد پاسخ دهید.
امضا:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (عکس فوری: QueryDocumentSnapshot ، زمینه: EventContext <ParamsOf<Path>>) => PromiseLike<any> | هر |
برمی گرداند:
CloudFunction < QueryDocumentSnapshot >
firestore.DocumentBuilder.onUpdate()
فقط به به روز رسانی اسناد پاسخ دهید.
امضا:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (تغییر: تغییر < QueryDocumentSnapshot >، زمینه: EventContext <ParamsOf<Path>>) => PromiseLike<any> | هر |
برمی گرداند:
CloudFunction < تغییر < QueryDocumentSnapshot >>
firestore.DocumentBuilder.onWrite()
به تمام نوشته‌های سند (ایجاد، به‌روزرسانی یا حذف) پاسخ دهید.
امضا:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| کنترل کننده | (تغییر: تغییر < DocumentSnapshot >، زمینه: EventContext <ParamsOf<Path>>) => PromiseLike<any> | هر |
برمی گرداند:
CloudFunction < تغییر < DocumentSnapshot >>