DocumentReference đề cập đến một vị trí tài liệu trong cơ sở dữ liệu Firestore và có thể được sử dụng để viết, đọc hoặc nghe vị trí đó. Tài liệu tại vị trí được tham chiếu có thể tồn tại hoặc không.
Chữ ký:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Của cải
| Tài sản | sửa đổi | Kiểu | Sự miêu tả |
|---|---|---|---|
| bộ chuyển đổi | Bộ chuyển đổi dữ liệu Firestore <AppModelType, DbModelType> | vô giá trị | Nếu được cung cấp, FirestoreDataConverter được liên kết với phiên bản này. | |
| lò sưởi | lò sưởi | Phiên bản Firestore chứa tài liệu. Ví dụ: điều này rất hữu ích để thực hiện các giao dịch. | |
| nhận dạng | sợi dây | Mã định danh của tài liệu trong bộ sưu tập của nó. | |
| cha mẹ | Bộ sưu tập tham chiếu <AppModelType, DbModelType> | Bộ sưu tập mà DocumentReference này thuộc về. | |
| con đường | sợi dây | Một chuỗi biểu thị đường dẫn của tài liệu được tham chiếu (liên quan đến thư mục gốc của cơ sở dữ liệu). | |
| kiểu | (không khai báo) | Loại tham chiếu Firestore này. |
phương pháp
| Phương pháp | sửa đổi | Sự miêu tả |
|---|---|---|
| withConverter(bộ chuyển đổi) | Áp dụng trình chuyển đổi dữ liệu tùy chỉnh cho DocumentReference này, cho phép bạn sử dụng các đối tượng mô hình tùy chỉnh của riêng mình với Firestore. Khi bạn gọi setDoc() , getDoc() , v.v. với phiên bản DocumentReference được trả về, trình chuyển đổi được cung cấp sẽ chuyển đổi giữa dữ liệu Firestore thuộc loại NewDbModelType và loại tùy chỉnh NewAppModelType của bạn. | |
| withConverter(bộ chuyển đổi) | Loại bỏ bộ chuyển đổi hiện tại. |
DocumentReference.converter
Nếu được cung cấp, FirestoreDataConverter được liên kết với phiên bản này.
Chữ ký:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
DocumentReference.firestore
Phiên bản Firestore chứa tài liệu. Ví dụ: điều này rất hữu ích để thực hiện các giao dịch.
Chữ ký:
readonly firestore: Firestore;
DocumentReference.id
Mã định danh của tài liệu trong bộ sưu tập của nó.
Chữ ký:
get id(): string;
DocumentReference.parent
Bộ sưu tập mà DocumentReference này thuộc về.
Chữ ký:
get parent(): CollectionReference<AppModelType, DbModelType>;
DocumentReference.path
Một chuỗi biểu thị đường dẫn của tài liệu được tham chiếu (liên quan đến thư mục gốc của cơ sở dữ liệu).
Chữ ký:
get path(): string;
DocumentReference.type
Loại tham chiếu Firestore này.
Chữ ký:
readonly type = "document";
DocumentReference.withConverter()
Áp dụng trình chuyển đổi dữ liệu tùy chỉnh cho DocumentReference này , cho phép bạn sử dụng các đối tượng mô hình tùy chỉnh của riêng mình với Firestore. Khi bạn gọi setDoc() , getDoc() , v.v. với phiên bản DocumentReference được trả về, trình chuyển đổi được cung cấp sẽ chuyển đổi giữa dữ liệu Firestore thuộc loại NewDbModelType và loại tùy chỉnh NewAppModelType của bạn .
Chữ ký:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| bộ chuyển đổi | Bộ chuyển đổi dữ liệu Firestore <NewAppModelType, NewDbModelType> | Chuyển đổi các đối tượng đến và đi từ Firestore. |
Trả về:
Tài liệu tham khảo <NewAppModelType, NewDbModelType>
DocumentReference sử dụng trình chuyển đổi được cung cấp.
DocumentReference.withConverter()
Loại bỏ bộ chuyển đổi hiện tại.
Chữ ký:
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
Thông số
| Tham số | Kiểu | Sự miêu tả |
|---|---|---|
| bộ chuyển đổi | vô giá trị | null loại bỏ bộ chuyển đổi hiện tại. |
Trả về:
Tài liệu tham khảo < Dữ liệu tài liệu , Dữ liệu tài liệu >
DocumentReference<DocumentData, DocumentData> không sử dụng trình chuyển đổi.