firestore namespace

Funkcje

Funkcjonować Opis
onDocumentCreated(dokument, procedura obsługi) Obsługa zdarzeń uruchamiana po utworzeniu dokumentu w Firestore.
onDocumentCreated (opcje, procedura obsługi) Obsługa zdarzeń uruchamiana po utworzeniu dokumentu w Firestore.
onDocumentDeleted(dokument, procedura obsługi) Obsługa zdarzeń uruchamiana po usunięciu dokumentu w Firestore.
onDocumentDeleted (opcje, procedura obsługi) Obsługa zdarzeń uruchamiana po usunięciu dokumentu w Firestore.
onDocumentUpdated(dokument, procedura obsługi) Obsługa zdarzeń uruchamiana po aktualizacji dokumentu w Firestore.
onDocumentUpdated (opcje, procedura obsługi) Obsługa zdarzeń uruchamiana po aktualizacji dokumentu w Firestore.
onDocumentWritten(dokument, procedura obsługi) Obsługa zdarzeń, która uruchamia się, gdy dokument jest tworzony, aktualizowany lub usuwany w Firestore.
onDocumentWritten (opcje, procedura obsługi) Obsługa zdarzeń, która uruchamia się, gdy dokument jest tworzony, aktualizowany lub usuwany w Firestore.

Zajęcia

Klasa Opis
Zmiana Interfejs Cloud Functions dla zdarzeń zmieniających stan, takich jak zdarzenia Realtime Database lub Cloud Firestore onWrite i onUpdate . Więcej informacji na temat formatu używanego do konstruowania obiektów Change można znaleźć poniżej.

Interfejsy

Interfejs Opis
Opcje dokumentu DocumentOptions rozszerzają EventHandlerOptions o dostarczony dokument i opcjonalną bazę danych i przestrzeń nazw.
Wydarzenie Firestore CloudEvent zawierający DocumentSnapshot lub zmianę

Wpisz aliasy

Wpisz Alias Opis
Zrzut dokumentu Migawka dokumentu Firestore
ZapytanieDokumentSnapshot Migawka Dokumentu zapytania Firestore

firestore.onDocumentCreated()

Obsługa zdarzeń uruchamiana 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, która ma zostać uruchomiona.
treser (zdarzenie: FirestoreEvent < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń, która jest uruchamiana za każdym razem, gdy następuje utworzenie Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentCreated()

Obsługa zdarzeń uruchamiana 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
decyduje się Opcje dokumentu <Dokument> Opcje, które można ustawić dla indywidualnej funkcji obsługi zdarzeń.
treser (zdarzenie: FirestoreEvent < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń, która jest uruchamiana za każdym razem, gdy następuje utworzenie Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentDeleted()

Obsługa zdarzeń uruchamiana 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, która ma zostać uruchomiona.
treser (zdarzenie: FirestoreEvent < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń uruchamiana za każdym razem, gdy następuje usunięcie Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentDeleted()

Obsługa zdarzeń uruchamiana 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
decyduje się Opcje dokumentu <Dokument> Opcje, które można ustawić dla indywidualnej funkcji obsługi zdarzeń.
treser (zdarzenie: FirestoreEvent < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń uruchamiana za każdym razem, gdy następuje usunięcie Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Migawka Dokumentu Zapytania | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentUpdated()

Obsługa zdarzeń uruchamiana po aktualizacji 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, która ma zostać uruchomiona.
treser (zdarzenie: FirestoreEvent < Zmień < QueryDocumentSnapshot > | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń uruchamiana za każdym razem, gdy następuje aktualizacja Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Zmień < QueryDocumentSnapshot > | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentUpdated()

Obsługa zdarzeń uruchamiana po aktualizacji 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
decyduje się Opcje dokumentu <Dokument> Opcje, które można ustawić dla indywidualnej funkcji obsługi zdarzeń.
treser (zdarzenie: FirestoreEvent < Zmień < QueryDocumentSnapshot > | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń uruchamiana za każdym razem, gdy następuje aktualizacja Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Zmień < QueryDocumentSnapshot > | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentWritten()

Obsługa zdarzeń, która uruchamia się, gdy dokument jest tworzony, aktualizowany lub usuwany 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, która ma zostać uruchomiona.
treser (zdarzenie: FirestoreEvent < Zmień < Migawka dokumentu > | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń uruchamiana za każdym razem, gdy nastąpi utworzenie, aktualizacja lub usunięcie Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Zmień < Migawka dokumentu > | niezdefiniowany, ParamsOf <Dokument>>>

firestore.onDocumentWritten()

Obsługa zdarzeń, która uruchamia się, gdy dokument jest tworzony, aktualizowany lub usuwany 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
decyduje się Opcje dokumentu <Dokument> Opcje, które można ustawić dla indywidualnej funkcji obsługi zdarzeń.
treser (zdarzenie: FirestoreEvent < Zmień < Migawka dokumentu > | niezdefiniowany, ParamsOf <Dokument>>) => dowolny | Obiecaj<jakiekolwiek> Obsługa zdarzeń uruchamiana za każdym razem, gdy nastąpi utworzenie, aktualizacja lub usunięcie Firestore.

Zwroty:

Funkcja chmury < Zdarzenie Firestore < Zmień < Migawka dokumentu > | niezdefiniowany, ParamsOf <Dokument>>>

firestore.DocumentSnapshot

Migawka dokumentu Firestore

Podpis:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Migawka Dokumentu zapytania Firestore

Podpis:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;