DocumentReference به یک مکان سند در پایگاه داده Firestore اشاره دارد و می تواند برای نوشتن، خواندن یا گوش دادن به مکان مورد استفاده قرار گیرد. سند در محل ارجاع ممکن است وجود داشته باشد یا نباشد.
امضا:
export declare class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
خواص
| ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
|---|---|---|---|
| مبدل | FirestoreDataConverter <AppModelType، DbModelType> | خالی | در صورت ارائه، FirestoreDataConverter مرتبط با این نمونه است. | |
| آتش نشانی | آتش نشانی | نمونه Firestore سند در آن است. این برای انجام معاملات مفید است، برای مثال. | |
| شناسه | رشته | شناسه سند در مجموعه آن. | |
| والدین | مرجع مجموعه <AppModelType، DbModelType> | مجموعه ای که این DocumentReference به آن تعلق دارد. | |
| مسیر | رشته | رشته ای که مسیر سند ارجاع شده را نشان می دهد (نسبت به ریشه پایگاه داده). | |
| نوع | (اعلام نشده) | نوع این مرجع Firestore. |
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| withConverter (مبدل) | یک مبدل داده سفارشی را در این DocumentReference اعمال می‌کند که به شما امکان می‌دهد از اشیاء مدل سفارشی خود با Firestore استفاده کنید. وقتی با setDoc () تماس می گیرید ، getDoc() و غیره با نمونه DocumentReference بازگشتی، مبدل ارائه شده بین داده های Firestore از نوع NewDbModelType و نوع سفارشی شما NewAppModelType تبدیل می کند. | |
| withConverter (مبدل) | مبدل جریان را حذف می کند. |
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 مبدل فعلی را حذف می کند. |
برمی گرداند:
مرجع سند < DocumentData , DocumentData >
یک DocumentReference<DocumentData, DocumentData> که از مبدل استفاده نمی کند.