CollectionReference class

یک شی CollectionReference را می توان برای افزودن اسناد، دریافت ارجاع اسناد، و پرس و جو برای اسناد استفاده کرد (با استفاده از query() ).

امضا:

export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> 

بسط می دهد: پرس و جو <AppModelType، DbModelType>

خواص

ویژگی	اصلاح کننده ها	تایپ کنید	شرح
شناسه		رشته	شناسه مجموعه
والدین		مرجع سند < DocumentData , DocumentData > | خالی	ارجاع به DocumentReference حاوی اگر این یک مجموعه فرعی است. اگر این یک مجموعه فرعی نیست، مرجع صفر است.
مسیر		رشته	رشته ای که مسیر مجموعه ارجاع شده را نشان می دهد (نسبت به ریشه پایگاه داده).
نوع		(اعلام نشده)	نوع این مرجع Firestore.

مواد و روش ها

روش	اصلاح کننده ها	شرح
withConverter (مبدل)		یک مبدل داده سفارشی را در این CollectionReference اعمال می‌کند که به شما امکان می‌دهد از اشیاء مدل سفارشی خود با Firestore استفاده کنید. هنگامی که با نمونه CollectionReference برگشتی، addDoc را فرا می‌خوانید، مبدل ارائه شده بین داده‌های Firestore از نوع NewDbModelType و نوع سفارشی شما NewAppModelType تبدیل می‌کند.
withConverter (مبدل)		مبدل جریان را حذف می کند.

CollectionReference.id

شناسه مجموعه

امضا:

get id(): string;

CollectionReference.parent

ارجاع به DocumentReference حاوی اگر این یک مجموعه فرعی است. اگر این یک مجموعه فرعی نیست، مرجع صفر است.

امضا:

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

CollectionReference.path

رشته ای که مسیر مجموعه ارجاع شده را نشان می دهد (نسبت به ریشه پایگاه داده).

امضا:

get path(): string;

CollectionReference.type

نوع این مرجع Firestore.

امضا:

readonly type = "collection";

CollectionReference.withConverter()

یک مبدل داده سفارشی را برای این CollectionReference اعمال می کند ، به شما امکان می دهد از اشیاء مدل سفارشی خود با Firestore استفاده کنید. هنگامی که ()addoc را با نمونه CollectionReference برگشتی فراخوانی می کنید، مبدل ارائه شده بین داده های Firestore از نوع NewDbModelType و نوع سفارشی شما NewAppModelType تبدیل می کند. .

امضا:

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

مولفه های

پارامتر	تایپ کنید	شرح
مبدل	FirestoreDataConverter <NewAppModelType، NewDbModelType>	اشیاء را به و از Firestore تبدیل می کند.

برمی گرداند:

مرجع مجموعه <NewAppModelType، NewDbModelType>

یک CollectionReference که از مبدل ارائه شده استفاده می کند.

CollectionReference.withConverter()

مبدل جریان را حذف می کند.

امضا:

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

مولفه های

پارامتر	تایپ کنید	شرح
مبدل	خالی	null مبدل فعلی را حذف می کند.

برمی گرداند:

مرجع مجموعه < DocumentData , DocumentData >

CollectionReference<DocumentData, DocumentData> که از مبدل استفاده نمی کند.