DocumentReference หมายถึงตำแหน่งเอกสารในฐานข้อมูล Firestore และสามารถใช้เพื่อเขียน อ่าน หรือฟังตำแหน่งได้ เอกสารในตำแหน่งที่อ้างอิงอาจมีหรือไม่มีอยู่
ลายเซ็น:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
พร็อพเพอร์ตี้
| พร็อพเพอร์ตี้ | คีย์ตัวปรับแต่ง | ประเภท | คำอธิบาย |
|---|---|---|---|
| ตัวแปลงสัญญาณ | FirestoreDataConverter<AppModelType, DbModelType> | ค่าว่าง | หากระบุ FirestoreDataConverter ที่เชื่อมโยงกับอินสแตนซ์นี้ |
|
| Firestore | Firestore | อินสแตนซ์ Firestore ที่มีเอกสารอยู่ ซึ่งจะเป็นประโยชน์ในการดำเนินการ เป็นต้น | |
| id | สตริง | ตัวระบุของเอกสารภายในคอลเล็กชัน | |
| หลัก | CollectionReference<AppModelType, DbModelType> | คอลเล็กชันที่มีDocumentReferenceนี้อยู่ |
|
| เส้นทาง | สตริง | สตริงที่แสดงเส้นทางของเอกสารที่อ้างอิง (สัมพันธ์กับรากของฐานข้อมูล) | |
| ประเภท | (ไม่ได้ประกาศ) | ประเภทของการอ้างอิง Firestore นี้ |
เมธอด
| วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
|---|---|---|
| withConverter(ตัวแปลง) | ใช้เครื่องมือแปลงข้อมูลที่กำหนดเองกับ DocumentReference นี้ ซึ่งจะช่วยให้คุณใช้ออบเจ็กต์โมเดลที่กำหนดเองกับ Firestore ได้ เมื่อคุณเรียกใช้ setDoc(), getDoc() ฯลฯ ด้วยอินสแตนซ์ DocumentReference ที่แสดงผล ตัวแปลงที่ระบุจะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภทที่กำหนดเอง NewAppModelType |
|
| withConverter(ตัวแปลง) | นำตัวแปลงปัจจุบันออก |
DocumentReference.converter
หากระบุ FirestoreDataConverter ที่เชื่อมโยงกับอินสแตนซ์นี้
ลายเซ็น:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
อินสแตนซ์ Firestore ที่มีเอกสารอยู่ ซึ่งจะเป็นประโยชน์ในการดำเนินการ เป็นต้น
ลายเซ็น:
readonly firestore: Firestore;
DocumentReference.id
ตัวระบุของเอกสารภายในคอลเล็กชัน
ลายเซ็น:
get id(): string;
DocumentReference.parent
คอลเล็กชันที่มีDocumentReferenceนี้อยู่
ลายเซ็น:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.path
สตริงที่แสดงเส้นทางของเอกสารที่อ้างอิง (สัมพันธ์กับรากของฐานข้อมูล)
ลายเซ็น:
get path(): string;
DocumentReference.type
ประเภทของการอ้างอิง Firestore นี้
ลายเซ็น:
readonly type = "document";
DocumentReference.withConverter()
ใช้เครื่องมือแปลงข้อมูลที่กำหนดเองกับ DocumentReference นี้ ซึ่งจะช่วยให้คุณใช้ออบเจ็กต์โมเดลที่กำหนดเองกับ Firestore ได้ เมื่อคุณเรียกใช้ setDoc(), getDoc() ฯลฯ ด้วยอินสแตนซ์ DocumentReference ที่แสดงผล ตัวแปลงที่ระบุจะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภทที่กำหนดเอง NewAppModelType
ลายเซ็น:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ผู้ทำ Conversion | FirestoreDataConverter<NewAppModelType, NewDbModelType> | แปลงออบเจ็กต์เป็นและจาก Firestore |
การคืนสินค้า:
DocumentReference<NewAppModelType, NewDbModelType>
DocumentReference ที่ใช้ตัวแปลงที่ระบุ
DocumentReference.withConverter()
นำตัวแปลงปัจจุบันออก
ลายเซ็น:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
| ผู้ทำ Conversion | Null | null นำตัวแปลงปัจจุบันออก |
การคืนสินค้า:
DocumentReference<DocumentData, DocumentData>
DocumentReference<DocumentData, DocumentData> ที่ไม่ได้ใช้ตัวแปลง