firestore namespace

ฟังก์ชั่น

การทำงาน คำอธิบาย
onDocumentCreated (เอกสาร, ตัวจัดการ) ตัวจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้างเอกสารใน Firestore
onDocumentCreated (ตัวเลือก ตัวจัดการ) ตัวจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้างเอกสารใน Firestore
onDocumentDeleted(เอกสาร, ตัวจัดการ) ตัวจัดการเหตุการณ์ซึ่งจะทริกเกอร์เมื่อเอกสารถูกลบใน Firestore
onDocumentDeleted (ตัวเลือก ตัวจัดการ) ตัวจัดการเหตุการณ์ซึ่งจะทริกเกอร์เมื่อเอกสารถูกลบใน Firestore
onDocumentUpdated (เอกสาร ตัวจัดการ) ตัวจัดการเหตุการณ์ซึ่งจะทริกเกอร์เมื่อมีการอัปเดตเอกสารใน Firestore
onDocumentUpdated (ตัวเลือก ตัวจัดการ) ตัวจัดการเหตุการณ์ซึ่งจะทริกเกอร์เมื่อมีการอัปเดตเอกสารใน Firestore
onDocumentWritten(เอกสาร, ตัวจัดการ) ตัวจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้าง อัปเดต หรือลบเอกสารใน Firestore
onDocumentWritten (ตัวเลือก, ตัวจัดการ) ตัวจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้าง อัปเดต หรือลบเอกสารใน Firestore

ชั้นเรียน

ระดับ คำอธิบาย
เปลี่ยน อินเทอร์เฟซ Cloud Functions สำหรับเหตุการณ์ที่เปลี่ยนสถานะ เช่น Realtime Database หรือ Cloud Firestore onWrite และ onUpdate events สำหรับข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบที่ใช้ในการสร้างวัตถุ Change โปรดดูด้านล่าง

อินเทอร์เฟซ

อินเตอร์เฟซ คำอธิบาย
ตัวเลือกเอกสาร DocumentOptions ขยาย EventHandlerOptions ด้วยเอกสารและฐานข้อมูลเสริมและเนมสเปซที่จัดเตรียมไว้ให้
FirestoreEvent CloudEvent ที่มี DocumentSnapshot หรือการเปลี่ยนแปลง

พิมพ์นามแฝง

พิมพ์นามแฝง คำอธิบาย
DocumentSnapshot เอกสาร Firestore DocumentSnapshot
QueryDocumentSnapshot Firestore QueryDocumentSnapshot

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

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < 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

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < 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

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < 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

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < 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

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < เปลี่ยน < 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

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < เปลี่ยน < 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 สร้าง อัปเดต หรือลบเกิดขึ้น

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < เปลี่ยน < สแนปช็อตเอกสาร > | ไม่ได้กำหนด 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 สร้าง อัปเดต หรือลบเกิดขึ้น

ผลตอบแทน:

คลาวด์ฟังก์ชัน < กิจกรรม Firestore < เปลี่ยน < สแนปช็อตเอกสาร > | ไม่ได้กำหนด ParamsOf <เอกสาร>>>

firestore.DocumentSnapshot

เอกสาร Firestore DocumentSnapshot

ลายเซ็น:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Firestore QueryDocumentSnapshot

ลายเซ็น:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;