Assinatura:
export declare class DocumentBuilder<Path extends string>
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)(triggerResource, opções) | Cria uma nova instância da classe DocumentBuilder |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| onCreate(handler) | Responda apenas a criações de documentos. | |
| onDelete(handler) | Responda apenas a exclusões de documentos. | |
| onUpdate(handler) | Responda apenas às atualizações nos documentos. | |
| onWrite(gerenciador) | Responder a todas as gravações de documentos (criações, atualizações ou exclusões). |
firestore.DocumentBuilder.(construtor)
Cria uma nova instância da classe DocumentBuilder
Assinatura:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| triggerResource | () => corda | |
| options | DeploymentOptions (em inglês) |
firestore.DocumentBuilder.onCreate()
Responda apenas a criações de documentos.
Assinatura:
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| handler | (snapshot: QueryDocumentSnapshot, contexto: EventContext<ParamsOf<Path>>) => Promessa como<qualquer> | nenhum |
Retorna:
CloudFunction<QueryDocumentSnapshot>
firestore.DocumentBuilder.onDelete()
Responda apenas a exclusões de documentos.
Assinatura:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| handler | (snapshot: QueryDocumentSnapshot, contexto: EventContext<ParamsOf<Path>>) => Promessa como<qualquer> | nenhum |
Retorna:
CloudFunction<QueryDocumentSnapshot>
firestore.DocumentBuilder.onUpdate()
Responda apenas às atualizações nos documentos.
Assinatura:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| handler | (alterar: Alterar<QueryDocumentSnapshot>, contexto: EventContext<ParamsOf<Path>>) => Promessa como<qualquer> | nenhum |
Retorna:
CloudFunction<Alterar<QueryDocumentSnapshot>>
firestore.DocumentBuilder.onWrite().
Responder a todas as gravações de documentos (criações, atualizações ou exclusões).
Assinatura:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| handler | (alterar: Alterar<DocumentSnapshot>, contexto: EventContext<ParamsOf<Path>>) => Promessa como<qualquer> | nenhum |
Retorna:
CloudFunction<Alterar<DocumentSnapshot>>