Funktionen
| Funktion | Beschreibung |
|---|---|
| onDocumentCreated(Dokument, Handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt wird. |
| onDocumentCreated(opts, handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt wird. |
| onDocumentDeleted(Dokument, Handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore gelöscht wird. |
| onDocumentDeleted(opts, handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore gelöscht wird. |
| onDocumentUpdated(Dokument, Handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore aktualisiert wird. |
| onDocumentUpdated(opts, handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore aktualisiert wird. |
| onDocumentWritten(Dokument, Handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt, aktualisiert oder gelöscht wird. |
| onDocumentWritten(opts, handler) | Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt, aktualisiert oder gelöscht wird. |
Klassen
| Klasse | Beschreibung |
|---|---|
| Ändern | Die Cloud Functions-Schnittstelle für Ereignisse, die ihren Status ändern, z. B. Echtzeitdatenbank- oder Cloud Firestore- onWrite und onUpdate Ereignisse. Weitere Informationen zum Format, das zum Erstellen Change Objekten verwendet wird, finden Sie unten. |
Schnittstellen
| Schnittstelle | Beschreibung |
|---|---|
| Dokumentoptionen | DocumentOptions erweitern EventHandlerOptions um das bereitgestellte Dokument und optionale Datenbank und Namespace. |
| FirestoreEvent | Ein CloudEvent, das einen DocumentSnapshot oder eine Änderung enthält |
Geben Sie Aliase ein
| Geben Sie Alias ein | Beschreibung |
|---|---|
| DocumentSnapshot | Ein Firestore-Dokument-Snapshot |
| QueryDocumentSnapshot | Ein Firestore QueryDocumentSnapshot |
firestore.onDocumentCreated()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| dokumentieren | Dokumentieren | Der Firestore-Dokumentpfad, auf den ausgelöst werden soll. |
| Handler | (Ereignis: FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn eine Firestore-Erstellung erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentCreated()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| optiert | Dokumentoptionen <Dokument> | Optionen, die für eine einzelne Ereignisverarbeitungsfunktion festgelegt werden können. |
| Handler | (Ereignis: FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn eine Firestore-Erstellung erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentDeleted()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore gelöscht wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| dokumentieren | Dokumentieren | Der Firestore-Dokumentpfad, auf den ausgelöst werden soll. |
| Handler | (Ereignis: FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn ein Firestore-Löschvorgang erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentDeleted()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore gelöscht wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| optiert | Dokumentoptionen <Dokument> | Optionen, die für eine einzelne Ereignisverarbeitungsfunktion festgelegt werden können. |
| Handler | (Ereignis: FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn ein Firestore-Löschvorgang erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < QueryDocumentSnapshot | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentUpdated()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore aktualisiert wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| dokumentieren | Dokumentieren | Der Firestore-Dokumentpfad, auf den ausgelöst werden soll. |
| Handler | (Ereignis: FirestoreEvent < Ändern < QueryDocumentSnapshot > | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn ein Firestore-Update erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < Ändern < QueryDocumentSnapshot > | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentUpdated()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore aktualisiert wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| optiert | Dokumentoptionen <Dokument> | Optionen, die für eine einzelne Ereignisverarbeitungsfunktion festgelegt werden können. |
| Handler | (Ereignis: FirestoreEvent < Ändern < QueryDocumentSnapshot > | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn ein Firestore-Update erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < Ändern < QueryDocumentSnapshot > | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentWritten()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt, aktualisiert oder gelöscht wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| dokumentieren | Dokumentieren | Der Firestore-Dokumentpfad, auf den ausgelöst werden soll. |
| Handler | (Ereignis: FirestoreEvent < Ändern < DocumentSnapshot > | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn eine Firestore-Erstellung, -Aktualisierung oder -Löschung erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < Ändern < DocumentSnapshot > | undefiniert, ParamsOf <Dokument>>>
firestore.onDocumentWritten()
Ereignishandler, der ausgelöst wird, wenn ein Dokument in Firestore erstellt, aktualisiert oder gelöscht wird.
Unterschrift:
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>>>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| optiert | Dokumentoptionen <Dokument> | Optionen, die für eine einzelne Ereignisverarbeitungsfunktion festgelegt werden können. |
| Handler | (Ereignis: FirestoreEvent < Ändern < DocumentSnapshot > | undefiniert, ParamsOf <Dokument>>) => beliebig | Versprochen<any> | Ereignishandler, der jedes Mal ausgeführt wird, wenn eine Firestore-Erstellung, -Aktualisierung oder -Löschung erfolgt. |
Kehrt zurück:
CloudFunction < FirestoreEvent < Ändern < DocumentSnapshot > | undefiniert, ParamsOf <Dokument>>>
firestore.DocumentSnapshot
Ein Firestore-Dokument-Snapshot
Unterschrift:
export type DocumentSnapshot = firestore.DocumentSnapshot;
firestore.QueryDocumentSnapshot
Ein Firestore QueryDocumentSnapshot
Unterschrift:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;