ลายเซ็น:
export declare class DocumentBuilder<Path extends string>
ผู้ผลิต
| ผู้ผลิต | คีย์ตัวปรับแต่ง | คำอธิบาย |
|---|---|---|
| (constructor)(triggerResource, ตัวเลือก) | สร้างอินสแตนซ์ใหม่ของคลาส DocumentBuilder |
เมธอด
| วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
|---|---|---|
| onCreate(แฮนเดิล) | ตอบกลับเฉพาะการสร้างเอกสาร | |
| onDelete(แฮนเดิล) | ตอบกลับเฉพาะการลบเอกสาร | |
| onUpdate(แฮนเดิล) | ตอบกลับเฉพาะการอัปเดตเอกสาร | |
| onWrite(แฮนเดิล) | ตอบกลับการเขียนเอกสารทั้งหมด (สร้าง อัปเดต หรือลบ) |
Firestore.DocumentBuilder (ตัวสร้าง)
สร้างอินสแตนซ์ใหม่ของคลาส DocumentBuilder
ลายเซ็น:
constructor(triggerResource: () => string, options: 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>>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ตัวแฮนเดิล | (change: เปลี่ยน<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>>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ตัวแฮนเดิล | (change: เปลี่ยน<DocumentSnapshot>, บริบท: EventContext<ParamsOf<Path>>) => PromiseLike<any> | ไม่จำกัด |
การคืนสินค้า:
CloudFunction<เปลี่ยน<DocumentSnapshot>>