Ta strona została przetłumaczona przez Cloud Translation API.

firestore namespace

Funkcje

Funkcja	Opis
onDocumentCreated(dokument, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu dokumentu w Firestore.
onDocumentCreated(opts, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu dokumentu w Firestore.
onDocumentRemove(dokument, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po usunięciu dokumentu w Firestore.
onDocumentUsunąć(opty, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po usunięciu dokumentu w Firestore.
onDocumentUpdated(dokument, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po zaktualizowaniu dokumentu w Firestore.
onDocumentUpdated(opts, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po zaktualizowaniu dokumentu w Firestore.
onDocumentWrite(dokument, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu, zaktualizowaniu lub usunięciu dokumentu w Firestore.
onDocumentWrite(opcje, moduł obsługi)	Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu, zaktualizowaniu lub usunięciu dokumentu w Firestore.

Zajęcia

Klasa	Opis
Zmień	Interfejs Cloud Functions dla zdarzeń, które zmieniają stan, takich jak Baza danych czasu rzeczywistego lub Cloud Firestore `onWrite` i `onUpdate`.Więcej informacji o formacie używanym do tworzenia obiektów `Change` znajdziesz poniżej.

Interfejsy

Interfejs	Opis
DocumentOptions	DocumentOptions rozszerzają EventHandlerOptions o udostępniony dokument oraz opcjonalną bazę danych i przestrzeń nazw.
Zdarzenie Firestore	Zdarzenie CloudEvent zawierające obiekt DocumentSnapshot lub zmianę

Aliasy typu

Wpisz alias	Opis
DocumentSnapshot	zrzut dokumentu Firestore
QueryDocumentSnapshot	Zrzut QueryDocumentSnapshot

Firestore.onDocumentCreated()

Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
dokument	Dokument	Ścieżka dokumentu Firestore, w przypadku której następuje uruchomienie.
moduł obsługi	(zdarzenie: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany przy każdym utworzeniu Firestore.

Zwroty:

Cloud Functions<FirestoreEvent<QueryDocumentSnapshot | niezdefiniowany, ParamsOf<Dokument>>>

Firestore.onDocumentCreated()

Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	DocumentOptions<Dokument>	Opcje, które można ustawić dla poszczególnych funkcji obsługi zdarzeń.
moduł obsługi	(zdarzenie: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany przy każdym utworzeniu Firestore.

Zwroty:

Cloud Functions<FirestoreEvent<QueryDocumentSnapshot | niezdefiniowany, ParamsOf<Dokument>>>

Firestore.onDocumentRemove()

Moduł obsługi zdarzeń, który jest wyzwalany po usunięciu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
dokument	Dokument	Ścieżka dokumentu Firestore, w przypadku której następuje uruchomienie.
moduł obsługi	(zdarzenie: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany przy każdym usunięciu operacji Firestore.

Zwroty:

Cloud Functions<FirestoreEvent<QueryDocumentSnapshot | niezdefiniowany, ParamsOf<Dokument>>>

Firestore.onDocumentRemove()

Moduł obsługi zdarzeń, który jest wyzwalany po usunięciu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	DocumentOptions<Dokument>	Opcje, które można ustawić dla poszczególnych funkcji obsługi zdarzeń.
moduł obsługi	(zdarzenie: FirestoreEvent<QueryDocumentSnapshot \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany przy każdym usunięciu operacji Firestore.

Zwroty:

Cloud Functions<FirestoreEvent<QueryDocumentSnapshot | niezdefiniowany, ParamsOf<Dokument>>>

Firestore.onDocumentUpdated()

Moduł obsługi zdarzeń, który jest wyzwalany po zaktualizowaniu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
dokument	Dokument	Ścieżka dokumentu Firestore, w przypadku której następuje uruchomienie.
moduł obsługi	(zdarzenie: FirestoreEvent<Change<QueryDocumentSnapshot> \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany przy każdej aktualizacji Firestore.

Zwroty:

Cloud Functions<FirestoreEvent<Zmień<QueryDocumentSnapshot> | niezdefiniowany, parametry<Dokument>>>

Firestore.onDocumentUpdated()

Moduł obsługi zdarzeń, który jest wyzwalany po zaktualizowaniu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	DocumentOptions<Dokument>	Opcje, które można ustawić dla poszczególnych funkcji obsługi zdarzeń.
moduł obsługi	(zdarzenie: FirestoreEvent<Change<QueryDocumentSnapshot> \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany przy każdej aktualizacji Firestore.

Zwroty:

Cloud Functions<FirestoreEvent<Zmień<QueryDocumentSnapshot> | niezdefiniowany, parametry<Dokument>>>

Firestore.onDocumentWrite()

Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu, zaktualizowaniu lub usunięciu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
dokument	Dokument	Ścieżka dokumentu Firestore, w przypadku której następuje uruchomienie.
moduł obsługi	(zdarzenie: FirestoreEvent<Change<DocumentSnapshot> \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany za każdym razem, gdy następuje utworzenie, zaktualizowanie lub usunięcie Firestore.

Zwroty:

CloudFunction<FirestoreEvent<Zmień<DocumentSnapshot> | niezdefiniowany, parametry<Dokument>>>

Firestore.onDocumentWrite()

Moduł obsługi zdarzeń, który jest wyzwalany po utworzeniu, zaktualizowaniu lub usunięciu dokumentu w Firestore.

Podpis:

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

Parametry

Parametr	Typ	Opis
opcje	DocumentOptions<Dokument>	Opcje, które można ustawić dla poszczególnych funkcji obsługi zdarzeń.
moduł obsługi	(zdarzenie: FirestoreEvent<Change<DocumentSnapshot> \| undefined, ParamsOf<Document>>) => dowolne \| Obietnica<any>	Moduł obsługi zdarzeń, który jest uruchamiany za każdym razem, gdy następuje utworzenie, zaktualizowanie lub usunięcie Firestore.

Zwroty:

CloudFunction<FirestoreEvent<Zmień<DocumentSnapshot> | niezdefiniowany, parametry<Dokument>>>

Firestore.DocumentSnapshot

zrzut dokumentu Firestore

Podpis:

export type DocumentSnapshot = firestore.DocumentSnapshot;

Firestore.QueryDocumentSnapshot

Zrzut QueryDocumentSnapshot

Podpis:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;