Đối tượng CollectionReference có thể được sử dụng để thêm tài liệu, lấy tham chiếu tài liệu và truy vấn tài liệu (sử dụng query() ).
Chữ ký:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Mở rộng: Truy vấn <AppModelType, DbModelType>
Của cải
| Tài sản | sửa đổi | Kiểu | Sự miêu tả |
|---|---|---|---|
| nhận dạng | sợi dây | Mã định danh của bộ sưu tập. | |
| cha mẹ | Tài liệu tham khảo < Dữ liệu tài liệu , Dữ liệu tài liệu > | vô giá trị | Một tham chiếu đến DocumentReference chứa nếu đây là một bộ sưu tập con. Nếu đây không phải là bộ sưu tập con thì tham chiếu sẽ rỗng. | |
| con đường | sợi dây | Một chuỗi biểu thị đường dẫn của bộ sưu tập đượ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 CollectionReference 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 addDoc() với phiên bản CollectionReference đượ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. |
Bộ sưu tậpReference.id
Mã định danh của bộ sưu tập.
Chữ ký:
get id(): string;
Bộ sưu tậpReference.parent
Một tham chiếu đến DocumentReference chứa nếu đây là một bộ sưu tập con. Nếu đây không phải là bộ sưu tập con thì tham chiếu sẽ rỗng.
Chữ ký:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
Bộ sưu tậpReference.path
Một chuỗi biểu thị đường dẫn của bộ sưu tập đượ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;
Bộ sưu tậpReference.type
Loại tham chiếu Firestore này.
Chữ ký:
readonly type = "collection";
CollectionReference.withConverter()
Áp dụng trình chuyển đổi dữ liệu tùy chỉnh cho CollectionReference 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 addDoc() với phiên bản CollectionReference đượ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>): CollectionReference<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ề:
Bộ sưu tập tham chiếu <NewAppModelType, NewDbModelType>
CollectionReference sử dụng trình chuyển đổi được cung cấp.
CollectionReference.withConverter()
Loại bỏ bộ chuyển đổi hiện tại.
Chữ ký:
withConverter(converter: null): CollectionReference<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ề:
Bộ sưu tập tham chiếu < Dữ liệu tài liệu , Dữ liệu tài liệu >
CollectionReference<DocumentData, DocumentData> không sử dụng trình chuyển đổi.