firestore namespace

ฟังก์ชัน

ฟังก์ชัน คำอธิบาย
onDocumentCreated(เอกสาร เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อสร้างเอกสารใน Firestore
onDocumentCreated(ตัวเลือก, เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อสร้างเอกสารใน Firestore
onDocumentDELETE(เอกสาร, เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อลบเอกสารใน Firestore
onDocumentdelete(ตัวเลือก เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อลบเอกสารใน Firestore
onDocumentUpdated(เอกสาร, เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่ออัปเดตเอกสารใน Firestore
onDocumentUpdated(ตัวเลือก, เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่ออัปเดตเอกสารใน Firestore
onDocumentWrched(เอกสาร, เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้าง อัปเดต หรือลบเอกสารใน Firestore
onDocumentWrched(ออปชัน, เครื่องจัดการ) เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้าง อัปเดต หรือลบเอกสารใน Firestore

ชั้นเรียน

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

อินเทอร์เฟซ

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

พิมพ์ชื่อแทน

พิมพ์ชื่อแทน คำอธิบาย
สแนปชอตเอกสาร สแนปชอตเอกสารของ Firestore
สแนปชอตของการค้นหาเอกสาร สแนปชอต QueryDocument ของ 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<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่มีการสร้าง Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | ไม่ได้กำหนด ParamsOf<Document>>>

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>>>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ตัวเลือก DocumentOptions<เอกสาร> ตัวเลือกที่สามารถตั้งค่าในฟังก์ชันการจัดการเหตุการณ์แต่ละรายการ
ตัวแฮนเดิล (เหตุการณ์: FirestoreEvent<QueryDocumentSnapshot | ไม่ได้กำหนด, ParamsOf<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่เรียกใช้ทุกครั้งที่มีการสร้าง Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | ไม่ได้กำหนด ParamsOf<Document>>>

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<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่มีการลบ Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | ไม่ได้กำหนด ParamsOf<Document>>>

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>>>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ตัวเลือก DocumentOptions<เอกสาร> ตัวเลือกที่สามารถตั้งค่าในฟังก์ชันการจัดการเหตุการณ์แต่ละรายการ
ตัวแฮนเดิล (เหตุการณ์: FirestoreEvent<QueryDocumentSnapshot | ไม่ได้กำหนด, ParamsOf<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่มีการลบ Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | ไม่ได้กำหนด ParamsOf<Document>>>

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<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่มีการอัปเดต Firestore

การคืนสินค้า:

CloudFunction<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>>>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ตัวเลือก DocumentOptions<เอกสาร> ตัวเลือกที่สามารถตั้งค่าในฟังก์ชันการจัดการเหตุการณ์แต่ละรายการ
ตัวแฮนเดิล (เหตุการณ์: FirestoreEvent<เปลี่ยน<QueryDocumentSnapshot> | ไม่ได้กำหนด, ParamsOf<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่มีการอัปเดต Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<เปลี่ยน<QueryDocumentSnapshot> | ไม่ได้กำหนด, ParamsOf<เอกสาร>>>

Firestore.onDocumentWrtable()

เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้าง อัปเดต หรือลบเอกสารใน 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<เปลี่ยน<DocumentSnapshot> | ไม่ระบุ, ParamsOf<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่สร้าง อัปเดต หรือลบ Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<เปลี่ยน<DocumentSnapshot> | ไม่ได้กำหนด, ParamsOf<เอกสาร>>>

Firestore.onDocumentWrtable()

เครื่องจัดการเหตุการณ์ที่ทริกเกอร์เมื่อมีการสร้าง อัปเดต หรือลบเอกสารใน 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>>>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ตัวเลือก DocumentOptions<เอกสาร> ตัวเลือกที่สามารถตั้งค่าในฟังก์ชันการจัดการเหตุการณ์แต่ละรายการ
ตัวแฮนเดิล (เหตุการณ์: FirestoreEvent<เปลี่ยน<DocumentSnapshot> | ไม่ระบุ, ParamsOf<Document>>) => ทั้งหมด | สัญญา<ไม่จำกัด> ตัวแฮนเดิลเหตุการณ์ที่จะเรียกใช้ทุกครั้งที่สร้าง อัปเดต หรือลบ Firestore

การคืนสินค้า:

CloudFunction<FirestoreEvent<เปลี่ยน<DocumentSnapshot> | ไม่ได้กำหนด, ParamsOf<เอกสาร>>>

Firestore.DocumentSnapshot

สแนปชอตเอกสารของ Firestore

ลายเซ็น:

export type DocumentSnapshot = firestore.DocumentSnapshot;

Firestore.QueryDocumentSnapshot

สแนปชอต QueryDocument ของ Firestore

ลายเซ็น:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;