ลายเซ็น:
export declare class DocumentBuilder<Path extends string>
คอนสตรัคเตอร์
ตัวสร้าง | ตัวดัดแปลง | คำอธิบาย |
---|---|---|
(ตัวสร้าง) (ทรัพยากรทริกเกอร์ ตัวเลือก) | สร้างอินสแตนซ์ใหม่ของคลาส 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<ใด ๆ> | ใดๆ |
ผลตอบแทน:
คลาวด์ฟังก์ชัน < QueryDocumentSnapshot >
firestore.DocumentBuilder.onDelete()
ตอบสนองต่อการลบเอกสารเท่านั้น
ลายเซ็น:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวจัดการ | (ภาพรวม: QueryDocumentSnapshot บริบท: EventContext <ParamsOf<Path>>) => PromiseLike<ใด ๆ> | ใดๆ |
ผลตอบแทน:
คลาวด์ฟังก์ชัน < QueryDocumentSnapshot >
firestore.DocumentBuilder.onUpdate()
ตอบสนองต่อการอัพเดตเอกสารเท่านั้น
ลายเซ็น:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวจัดการ | (เปลี่ยน: เปลี่ยน < QueryDocumentSnapshot > บริบท: EventContext <ParamsOf<Path>>) => PromiseLike<ใดๆ> | ใดๆ |
ผลตอบแทน:
คลาวด์ฟังก์ชัน < เปลี่ยน < QueryDocumentSnapshot >>
firestore.DocumentBuilder.onWrite ()
ตอบสนองต่อการเขียนเอกสารทั้งหมด (สร้าง อัปเดต หรือลบ)
ลายเซ็น:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
ตัวจัดการ | (เปลี่ยน: เปลี่ยน < สแนปช็อตเอกสาร > บริบท: EventContext <ParamsOf<Path>>) => PromiseLike<ใดๆ> | ใดๆ |
ผลตอบแทน:
คลาวด์ฟังก์ชัน < เปลี่ยน < สแนปช็อตเอกสาร >>