Funções
| Função | Descrição |
|---|---|
| onDocumentCreated(documento, manipulador) | Manipulador de eventos que é acionado quando um documento é criado no Firestore. |
| onDocumentCreated(opções, manipulador) | Manipulador de eventos que é acionado quando um documento é criado no Firestore. |
| onDocumentDeleted(documento, manipulador) | Manipulador de eventos que é acionado quando um documento é excluído no Firestore. |
| onDocumentDeleted(opções, manipulador) | Manipulador de eventos que é acionado quando um documento é excluído no Firestore. |
| onDocumentUpdated(documento, manipulador) | Manipulador de eventos que é acionado quando um documento é atualizado no Firestore. |
| onDocumentUpdated(opções, manipulador) | Manipulador de eventos que é acionado quando um documento é atualizado no Firestore. |
| onDocumentWritten(documento, manipulador) | Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore. |
| onDocumentWritten(opções, manipulador) | Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore. |
Aulas
| Aula | Descrição |
|---|---|
| Mudar | A interface do Cloud Functions para eventos que mudam de estado, como eventos onWrite e onUpdate do Realtime Database ou do Cloud Firestore. Para obter mais informações sobre o formato usado para construir objetos Change , veja abaixo. |
Interfaces
| Interface | Descrição |
|---|---|
| Opções de documento | DocumentOptions estende EventHandlerOptions com documento fornecido e banco de dados e namespace opcionais. |
| Evento Firestore | Um CloudEvent que contém um DocumentSnapshot ou uma alteração |
Aliases de tipo
| Digite Alias | Descrição |
|---|---|
| Instantâneo do documento | Um instantâneo de documento do Firestore |
| QueryDocumentSnapshot | Um instantâneo do Firestore QueryDocument |
firestore.onDocumentCreated()
Manipulador de eventos que é acionado quando um documento é criado no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documento | Documento | O caminho do documento do Firestore para acionar. |
| manipulador | (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma criação do Firestore. |
Retorna:
Função Cloud < Evento Firestore < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>>
firestore.onDocumentCreated()
Manipulador de eventos que é acionado quando um documento é criado no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| opta | Opções de documento <Documento> | Opções que podem ser definidas em uma função individual de manipulação de eventos. |
| manipulador | (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma criação do Firestore. |
Retorna:
Função Cloud < Evento Firestore < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>>
firestore.onDocumentDeleted()
Manipulador de eventos que é acionado quando um documento é excluído no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documento | Documento | O caminho do documento do Firestore para acionar. |
| manipulador | (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma exclusão do Firestore. |
Retorna:
Função Cloud < Evento Firestore < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>>
firestore.onDocumentDeleted()
Manipulador de eventos que é acionado quando um documento é excluído no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| opta | Opções de documento <Documento> | Opções que podem ser definidas em uma função individual de manipulação de eventos. |
| manipulador | (evento: FirestoreEvent < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma exclusão do Firestore. |
Retorna:
Função Cloud < Evento Firestore < QueryDocumentSnapshot | indefinido, ParamsOf <Documento>>>
firestore.onDocumentUpdated()
Manipulador de eventos que é acionado quando um documento é atualizado no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documento | Documento | O caminho do documento do Firestore para acionar. |
| manipulador | (evento: FirestoreEvent < Alterar < QueryDocumentSnapshot > | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma atualização do Firestore. |
Retorna:
Função Cloud < Evento Firestore < Alterar < QueryDocumentSnapshot > | indefinido, ParamsOf <Documento>>>
firestore.onDocumentUpdated()
Manipulador de eventos que é acionado quando um documento é atualizado no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| opta | Opções de documento <Documento> | Opções que podem ser definidas em uma função individual de manipulação de eventos. |
| manipulador | (evento: FirestoreEvent < Alterar < QueryDocumentSnapshot > | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma atualização do Firestore. |
Retorna:
Função Cloud < Evento Firestore < Alterar < QueryDocumentSnapshot > | indefinido, ParamsOf <Documento>>>
firestore.onDocumentWritten()
Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| documento | Documento | O caminho do documento do Firestore para acionar. |
| manipulador | (evento: FirestoreEvent < Alterar < DocumentoInstantâneo > | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma criação, atualização ou exclusão do Firestore. |
Retorna:
Função Cloud < Evento Firestore < Alterar < DocumentoInstantâneo > | indefinido, ParamsOf <Documento>>>
firestore.onDocumentWritten()
Manipulador de eventos que é acionado quando um documento é criado, atualizado ou excluído no Firestore.
Assinatura:
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>>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| opta | Opções de documento <Documento> | Opções que podem ser definidas em uma função individual de manipulação de eventos. |
| manipulador | (evento: FirestoreEvent < Alterar < DocumentoInstantâneo > | indefinido, ParamsOf <Documento>>) => qualquer | Promessa<qualquer> | Manipulador de eventos que é executado sempre que ocorre uma criação, atualização ou exclusão do Firestore. |
Retorna:
Função Cloud < Evento Firestore < Alterar < DocumentoInstantâneo > | indefinido, ParamsOf <Documento>>>
firestore.DocumentSnapshot
Um instantâneo de documento do Firestore
Assinatura:
export type DocumentSnapshot = firestore.DocumentSnapshot;
firestore.QueryDocumentSnapshot
Um instantâneo do Firestore QueryDocument
Assinatura:
export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;