firestore namespace

פונקציות

פוּנקצִיָה תיאור
onDocumentCreated(מסמך, מטפל) מטפל באירועים המופעל כאשר מסמך נוצר ב-Firestore.
onDocumentCreated(opts, handler) מטפל באירועים המופעל כאשר מסמך נוצר ב-Firestore.
onDocumentDeleted(מסמך, מטפל) מטפל באירועים המופעל כאשר מסמך נמחק ב-Firestore.
onDocumentDeleted(opts, handler) מטפל באירועים המופעל כאשר מסמך נמחק ב-Firestore.
onDocumentUpdated(מסמך, מטפל) מטפל באירועים המופעל כאשר מסמך מתעדכן ב-Firestore.
onDocumentUpdated(opts, handler) מטפל באירועים המופעל כאשר מסמך מתעדכן ב-Firestore.
onDocumentWritten(מסמך, מטפל) מטפל באירועים המופעל כאשר מסמך נוצר, מתעדכן או נמחק ב-Firestore.
onDocumentWritten(opts, handler) מטפל באירועים המופעל כאשר מסמך נוצר, מתעדכן או נמחק ב-Firestore.

שיעורים

מעמד תיאור
שינוי ממשק ה-Cloud Functions עבור אירועים המשנים מצב, כגון Realtime Database או Cloud Firestore onWrite ו- onUpdate אירועים. למידע נוסף על הפורמט המשמש לבניית אובייקטי Change , ראה להלן.

ממשקים

מִמְשָׁק תיאור
DocumentOptions DocumentOptions מרחיב את EventHandlerOptions עם מסמך מסופק ומסד נתונים ומרחב שמות אופציונליים.
FirestoreEvent CloudEvent המכיל תצלום של DocumentSnapshot או שינוי

הקלד כינויים

הקלד כינוי תיאור
DocumentSnapshot תמונה של Firestore DocumentSnapshot
QueryDocumentSnapshot Firestore QueryDocumentSnapshot

firestore.onDocumentCreated()

מטפל באירועים המופעל כאשר מסמך נוצר ב-Firestore.

חֲתִימָה:

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מסמך מסמך נתיב המסמך של Firestore להפעלה.
מטפל (אירוע: FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחשת יצירת Firestore.

החזרות:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentCreated()

מטפל באירועים המופעל כאשר מסמך נוצר ב-Firestore.

חֲתִימָה:

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
בוחר DocumentOptions <מסמך> אפשרויות שניתן להגדיר בפונקציית טיפול באירועים בודדים.
מטפל (אירוע: FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחשת יצירת Firestore.

החזרות:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentDeleted()

מטפל באירועים המופעל כאשר מסמך נמחק ב-Firestore.

חֲתִימָה:

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מסמך מסמך נתיב המסמך של Firestore להפעלה.
מטפל (אירוע: FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחשת מחיקה של Firestore.

החזרות:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentDeleted()

מטפל באירועים המופעל כאשר מסמך נמחק ב-Firestore.

חֲתִימָה:

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
בוחר DocumentOptions <מסמך> אפשרויות שניתן להגדיר בפונקציית טיפול באירועים בודדים.
מטפל (אירוע: FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחשת מחיקה של Firestore.

החזרות:

CloudFunction < FirestoreEvent < QueryDocumentSnapshot | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentUpdated()

מטפל באירועים המופעל כאשר מסמך מתעדכן ב-Firestore.

חֲתִימָה:

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מסמך מסמך נתיב המסמך של Firestore להפעלה.
מטפל (אירוע: FirestoreEvent < שנה < QueryDocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחש עדכון Firestore.

החזרות:

CloudFunction < FirestoreEvent < שנה < QueryDocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentUpdated()

מטפל באירועים המופעל כאשר מסמך מתעדכן ב-Firestore.

חֲתִימָה:

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
בוחר DocumentOptions <מסמך> אפשרויות שניתן להגדיר בפונקציית טיפול באירועים בודדים.
מטפל (אירוע: FirestoreEvent < שנה < QueryDocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחש עדכון Firestore.

החזרות:

CloudFunction < FirestoreEvent < שנה < QueryDocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentWritten()

מטפל באירועים המופעל כאשר מסמך נוצר, מתעדכן או נמחק ב-Firestore.

חֲתִימָה:

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
מסמך מסמך נתיב המסמך של Firestore להפעלה.
מטפל (אירוע: FirestoreEvent < שנה < DocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחשת יצירה, עדכון או מחיקה של Firestore.

החזרות:

CloudFunction < FirestoreEvent < שנה < DocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>>

firestore.onDocumentWritten()

מטפל באירועים המופעל כאשר מסמך נוצר, מתעדכן או נמחק ב-Firestore.

חֲתִימָה:

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

פרמטרים

פָּרָמֶטֶר סוּג תיאור
בוחר DocumentOptions <מסמך> אפשרויות שניתן להגדיר בפונקציית טיפול באירועים בודדים.
מטפל (אירוע: FirestoreEvent < שנה < DocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>) => כל | מבטיח<כל> מטפל באירועים המופעל בכל פעם שמתרחשת יצירה, עדכון או מחיקה של Firestore.

החזרות:

CloudFunction < FirestoreEvent < שנה < DocumentSnapshot > | לא מוגדר, ParamsOf <מסמך>>>

firestore.DocumentSnapshot

תמונה של Firestore DocumentSnapshot

חֲתִימָה:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Firestore QueryDocumentSnapshot

חֲתִימָה:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;