firestore namespace

Funzioni

Funzione	Descrizione
onDocumentCreated(documento, gestore)	Gestore eventi che si attiva quando un documento viene creato in Firestore.
onDocumentCreated(opzioni, gestore)	Gestore eventi che si attiva quando un documento viene creato in Firestore.
onDocumentDeleted(documento, gestore)	Gestore eventi che si attiva quando un documento viene eliminato in Firestore.
onDocumentDeleted(opzioni, gestore)	Gestore eventi che si attiva quando un documento viene eliminato in Firestore.
onDocumentUpdated(documento, gestore)	Gestore eventi che si attiva quando un documento viene aggiornato in Firestore.
onDocumentUpdated(opzioni, gestore)	Gestore eventi che si attiva quando un documento viene aggiornato in Firestore.
onDocumentWritten(documento, gestore)	Gestore eventi che si attiva quando un documento viene creato, aggiornato o eliminato in Firestore.
onDocumentWritten(opzioni, gestore)	Gestore eventi che si attiva quando un documento viene creato, aggiornato o eliminato in Firestore.

Classi

Classe	Descrizione
Modifica	L'interfaccia Cloud Functions per gli eventi che cambiano stato, come gli eventi onWrite e onUpdate di Realtime Database o Cloud Firestore. Per ulteriori informazioni sul formato utilizzato per costruire oggetti Change , vedere di seguito.

Interfacce

Interfaccia	Descrizione
Opzioni documento	DocumentOptions estende EventHandlerOptions con il documento fornito, il database e lo spazio dei nomi opzionali.
Evento Firestore	Un CloudEvent che contiene un DocumentSnapshot o un Change

Digitare Alias

Digita Alias	Descrizione
Istantanea del documento	Uno snapshot del documento Firestore
QueryDocumentSnapshot	Uno snapshot QueryDocumentSnapshot di Firestore

firestore.onDocumentCreated()

Gestore eventi che si attiva quando un documento viene creato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
documento	Documento	Il percorso del documento Firestore su cui eseguire l'attivazione.
gestore	(evento: FirestoreEvent < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica una creazione Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>>

firestore.onDocumentCreated()

Gestore eventi che si attiva quando un documento viene creato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
opta	Opzioni documento <Documento>	Opzioni che possono essere impostate su una singola funzione di gestione degli eventi.
gestore	(evento: FirestoreEvent < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica una creazione Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>>

firestore.onDocumentDeleted()

Gestore eventi che si attiva quando un documento viene eliminato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
documento	Documento	Il percorso del documento Firestore su cui eseguire l'attivazione.
gestore	(evento: FirestoreEvent < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica un'eliminazione da Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>>

firestore.onDocumentDeleted()

Gestore eventi che si attiva quando un documento viene eliminato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
opta	Opzioni documento <Documento>	Opzioni che possono essere impostate su una singola funzione di gestione degli eventi.
gestore	(evento: FirestoreEvent < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica un'eliminazione da Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < QueryDocumentSnapshot | non definito, ParamsOf <Documento>>>

firestore.onDocumentUpdated()

Gestore eventi che si attiva quando un documento viene aggiornato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
documento	Documento	Il percorso del documento Firestore su cui eseguire l'attivazione.
gestore	(evento: FirestoreEvent < Cambia < QueryDocumentSnapshot > | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica un aggiornamento Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < Cambia < QueryDocumentSnapshot > | non definito, ParamsOf <Documento>>>

firestore.onDocumentUpdated()

Gestore eventi che si attiva quando un documento viene aggiornato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
opta	Opzioni documento <Documento>	Opzioni che possono essere impostate su una singola funzione di gestione degli eventi.
gestore	(evento: FirestoreEvent < Cambia < QueryDocumentSnapshot > | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica un aggiornamento Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < Cambia < QueryDocumentSnapshot > | non definito, ParamsOf <Documento>>>

firestore.onDocumentWritten()

Gestore eventi che si attiva quando un documento viene creato, aggiornato o eliminato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
documento	Documento	Il percorso del documento Firestore su cui eseguire l'attivazione.
gestore	(evento: FirestoreEvent < Cambia < Istantanea del documento > | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica una creazione, un aggiornamento o un'eliminazione di Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < Cambia < Istantanea del documento > | non definito, ParamsOf <Documento>>>

firestore.onDocumentWritten()

Gestore eventi che si attiva quando un documento viene creato, aggiornato o eliminato in Firestore.

Firma:

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>>>;

Parametri

Parametro	Tipo	Descrizione
opta	Opzioni documento <Documento>	Opzioni che possono essere impostate su una singola funzione di gestione degli eventi.
gestore	(evento: FirestoreEvent < Cambia < Istantanea del documento > | non definito, ParamsOf <Documento>>) => qualsiasi | Promesso<qualsiasi>	Gestore eventi che viene eseguito ogni volta che si verifica una creazione, un aggiornamento o un'eliminazione di Firestore.

Ritorna:

Funzione Cloud < Evento Firestore < Cambia < Istantanea del documento > | non definito, ParamsOf <Documento>>>

firestore.DocumentSnapshot

Uno snapshot del documento Firestore

Firma:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Uno snapshot QueryDocumentSnapshot di Firestore

Firma:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;