firestore namespace

İşlevler

İşlev Açıklama
onDocumentCreated(doküman, işleyici) Firestore'da bir doküman oluşturulduğunda tetiklenen etkinlik işleyici.
onDocumentCreated(opts, işleyici) Firestore'da bir doküman oluşturulduğunda tetiklenen etkinlik işleyici.
onDocumentSilinmiş(doküman, işleyici) Firestore'da bir belge silindiğinde tetiklenen etkinlik işleyici.
onDocumentSilinmiş(opts, işleyici) Firestore'da bir belge silindiğinde tetiklenen etkinlik işleyici.
onDocumentUpdated(doküman, işleyici) Firestore'da bir belge güncellendiğinde tetiklenen etkinlik işleyici.
onDocumentUpdated(opts, işleyici) Firestore'da bir belge güncellendiğinde tetiklenen etkinlik işleyici.
onDocument değişikliğini(doküman, işleyici) Firestore'da bir doküman oluşturulduğunda, güncellendiğinde veya silindiğinde tetiklenen etkinlik işleyici.
onDocument değişikliğini(opts, işleyici) Firestore'da bir doküman oluşturulduğunda, güncellendiğinde veya silindiğinde tetiklenen etkinlik işleyici.

Sınıflar

Sınıf Açıklama
Değiştir Realtime Database veya Cloud Firestore onWrite ve onUpdate etkinlikleri gibi durumu değişen etkinliklerin Cloud Functions arayüzü.Change nesnelerini oluşturmak için kullanılan biçim hakkında daha fazla bilgi için aşağıya bakın.

Arayüzler

Arayüz Açıklama
DocumentOptions DocumentOptions, EventHandlerOptions'ı sağlanan belgeyle, isteğe bağlı veritabanı ve ad alanıyla genişletir.
FirestoreEtkinlik DocumentSnapshot veya Değişiklik içeren bir CloudEvent

Tür Takma Adları

Takma Ad yazın Açıklama
DocumentSnapshot Firestore Belge Anlık Görüntüsü
QueryDocumentSnapshot Firestore QueryDocumentSnapshot

firestore.onDocumentCreated()

Firestore'da bir doküman oluşturulduğunda tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
doküman Doküman Tetiklenecek Firestore belge yolu.
handler (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore oluşturma işleminde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | tanımlanmamış, ParamsOf<Document>>>

firestore.onDocumentCreated()

Firestore'da bir doküman oluşturulduğunda tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
opt. DocumentOptions<Document> Bağımsız bir etkinlik işleme işlevinde ayarlanabilecek seçenekler.
handler (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore oluşturma işleminde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | tanımlanmamış, ParamsOf<Document>>>

firestore.onDocumentError()

Firestore'da bir belge silindiğinde tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
doküman Doküman Tetiklenecek Firestore belge yolu.
handler (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore silme işleminde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | tanımlanmamış, ParamsOf<Document>>>

firestore.onDocumentError()

Firestore'da bir belge silindiğinde tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
opt. DocumentOptions<Document> Bağımsız bir etkinlik işleme işlevinde ayarlanabilecek seçenekler.
handler (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore silme işleminde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<QueryDocumentSnapshot | tanımlanmamış, ParamsOf<Document>>>

firestore.onDocumentUpdated()

Firestore'da bir belge güncellendiğinde tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
doküman Doküman Tetiklenecek Firestore belge yolu.
handler (etkinlik: FirestoreEvent<Değiştir<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore güncellemesinde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<Değiştir<QueryDocumentSnapshot> | tanımsız, ParamsOf<Document>>>

firestore.onDocumentUpdated()

Firestore'da bir belge güncellendiğinde tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
opt. DocumentOptions<Document> Bağımsız bir etkinlik işleme işlevinde ayarlanabilecek seçenekler.
handler (etkinlik: FirestoreEvent<Değiştir<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore güncellemesinde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<Değiştir<QueryDocumentSnapshot> | tanımsız, ParamsOf<Document>>>

firestore.onDocumentWrite()

Firestore'da bir doküman oluşturulduğunda, güncellendiğinde veya silindiğinde tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
doküman Doküman Tetiklenecek Firestore belge yolu.
handler (etkinlik: FirestoreEvent<Değiştir<DocumentSnapshot> | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore oluşturma, güncelleme veya silme işlemi gerçekleştiğinde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<Değiştir<DocumentSnapshot> | tanımsız, ParamsOf<Document>>>

firestore.onDocumentWrite()

Firestore'da bir doküman oluşturulduğunda, güncellendiğinde veya silindiğinde tetiklenen etkinlik işleyici.

İmza:

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

Parametreler

Parametre Tür Açıklama
opt. DocumentOptions<Document> Bağımsız bir etkinlik işleme işlevinde ayarlanabilecek seçenekler.
handler (etkinlik: FirestoreEvent<Değiştir<DocumentSnapshot> | undefined, ParamsOf<Document>>) => herhangi biri | Söz veriyorum<herhangi biri> Her Firestore oluşturma, güncelleme veya silme işlemi gerçekleştiğinde çalıştırılan etkinlik işleyici.

Şunu döndürür:

CloudFunction<FirestoreEvent<Değiştir<DocumentSnapshot> | tanımsız, ParamsOf<Document>>>

firestore.DocumentSnapshot

Firestore Belge Anlık Görüntüsü

İmza:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Firestore QueryDocumentSnapshot

İmza:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;