CollectionReference class

Bạn có thể dùng đối tượng CollectionReference để thêm tài liệu, lấy thông tin 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>

Thuộc tính

Tài sản	Công cụ sửa đổi	Loại	Mô tả
id		chuỗi	Giá trị nhận dạng của bộ sưu tập.
cha mẹ		DocumentReference<DocumentData, documentData> | rỗng	Tham chiếu đến DocumentReference chứa nếu đây là bộ sưu tập con. Nếu đây không phải là bộ sưu tập con, thì giá trị tham chiếu sẽ rỗng.
đường dẫn		chuỗi	Một chuỗi đại diện cho đường dẫn của tập hợp được tham chiếu (tương ứng với gốc của cơ sở dữ liệu).
loại		(chưa khai báo)	Loại của tham chiếu Firestore này.

Phương thức

Phương thức	Công cụ sửa đổi	Mô tả
withConverter(converter) (Trình chuyển đổi)		Áp dụng trình chuyển đổi dữ liệu tuỳ chỉnh cho CollectionReference này, cho phép bạn sử dụng các đối tượng mô hình tuỳ chỉnh của riêng mình với Firestore. Khi bạn gọi addDoc() bằng thực thể 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 tuỳ chỉnh NewAppModelType.
withConverter(chuyển đổi)		Xoá bộ chuyển đổi hiện tại.

Bộ sưu tập.id

Giá trị nhận dạng của bộ sưu tập.

Chữ ký:

get id(): string;

Thu thậpTham chiếu.parent

Tham chiếu đến DocumentReference chứa nếu đây là bộ sưu tập con. Nếu đây không phải là bộ sưu tập con, thì giá trị tham chiếu sẽ rỗng.

Chữ ký:

get parent(): DocumentReference<DocumentData, DocumentData> | null;

Bộ sưu tậpReference.path

Một chuỗi đại diện cho đường dẫn của tập hợp được tham chiếu (tương ứng với gốc của cơ sở dữ liệu).

Chữ ký:

get path(): string;

Bộ sưu tập.type

Loại của tham chiếu Firestore này.

Chữ ký:

readonly type = "collection";

Bộ sưu tậpReference.withConverter()

Áp dụng trình chuyển đổi dữ liệu tuỳ chỉnh cho CollectionReference này, cho phép bạn sử dụng các đối tượng mô hình tuỳ chỉnh của riêng mình với Firestore. Khi bạn gọi addDoc() bằng thực thể 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 tuỳ chỉnh NewAppModelType.

Chữ ký:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;

Thông số

Thông số	Loại	Mô tả
người chuyển đổi	FirestoreDataConverter<NewAppModelType, NewDbModelType>	Chuyển đổi các đối tượng thành và từ Firestore.

Trường hợp trả lại hàng:

CollectionReference<NewAppModelType, NewDbModelType>

CollectionReference sử dụng trình chuyển đổi được cung cấp.

Bộ sưu tậpReference.withConverter()

Xoá bộ chuyển đổi hiện tại.

Chữ ký:

withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
người chuyển đổi	null	null sẽ xoá trình chuyển đổi hiện tại.

Trường hợp trả lại hàng:

CollectionReference<DocumentData, DocumentData>

CollectionReference<DocumentData, DocumentData> không sử dụng trình chuyển đổi.