DocumentReference מתייחס למיקום מסמך במסד נתונים של Firestore וניתן להשתמש בו כדי לכתוב, לקרוא או להאזין למיקום. המסמך במיקום הנזכר יכול להיות קיים או לא.
חֲתִימָה:
export declare class DocumentReference
נכסים
| תכונה | משנה | סוּג | תיאור |
|---|---|---|---|
| מֵמִיר | FirestoreDataConverter | אם מסופק, FirestoreDataConverter המשויך למופע זה. | |
| firestore | Firestore | מופע Firestore בו נמצא המסמך. זה שימושי לביצוע עסקאות, למשל. | |
| תְעוּדַת זֶהוּת | חוּט | מזהה המסמך באוסף שלו. | |
| הוֹרֶה | הפניה לאוסף | האוסף שאליו שייך DocumentReference זה. | |
| נָתִיב | חוּט | מחרוזת המייצגת את הנתיב של המסמך שהפניה אליו (ביחס לשורש מסד הנתונים). | |
| סוּג | (לא הוצהר) | סוג הפניה זו ל-Firestore. |
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| withConverter(converter) | מחיל ממיר נתונים מותאם אישית על DocumentReference זה, ומאפשר לך להשתמש באובייקטי מודל מותאם אישית משלך עם Firestore. כשאתה קורא ל-setDoc() , getDoc() , וכו' עם מופע DocumentReference שהוחזר, הממיר שסופק ימיר בין נתוני Firestore מסוג NewDbModelType לבין הסוג המותאם אישית שלך NewAppModelType . | |
| withConverter(converter) | מסיר את הממיר הנוכחי. |
DocumentReference.converter
אם מסופק, FirestoreDataConverter המשויך למופע זה.
חֲתִימָה:
readonly converter: FirestoreDataConverter | null;
DocumentReference.firestore
מופע Firestore בו נמצא המסמך. זה שימושי לביצוע עסקאות, למשל.
חֲתִימָה:
readonly firestore: Firestore;
DocumentReference.id
מזהה המסמך באוסף שלו.
חֲתִימָה:
get id(): string;
DocumentReference.parent
האוסף שאליו שייך DocumentReference זה.
חֲתִימָה:
get parent(): CollectionReference;
DocumentReference.path
מחרוזת המייצגת את הנתיב של המסמך שהפניה אליו (ביחס לשורש מסד הנתונים).
חֲתִימָה:
get path(): string;
DocumentReference.type
סוג הפניה זו ל-Firestore.
חֲתִימָה:
readonly type = "document";
DocumentReference.withConverter()
מחיל ממיר נתונים מותאם אישית על DocumentReference זה , המאפשר לך להשתמש באובייקטי מודל מותאם אישית משלך עם Firestore. כשאתה קורא ל-setDoc() , getDoc() , וכו' עם מופע DocumentReference שהוחזר, הממיר שסופק ימיר בין נתוני Firestore מסוג NewDbModelType לבין הסוג המותאם אישית שלך NewAppModelType .
חֲתִימָה:
withConverter(converter: FirestoreDataConverter): DocumentReference;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מֵמִיר | FirestoreDataConverter | ממירה אובייקטים אל Firestore וממנה. |
החזרות:
DocumentReference שמשתמש בממיר שסופק.
DocumentReference.withConverter()
מסיר את הממיר הנוכחי.
חֲתִימָה:
withConverter(converter: null): DocumentReference;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מֵמִיר | ריק | null מסיר את הממיר הנוכחי. |
החזרות:
הפניה למסמך < DocumentData , DocumentData >
DocumentReference שאינו משתמש בממיר.