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