firestore.DocumentBuilder class

Assinatura:

export declare class DocumentBuilder<Path extends string> 

Construtores

Construtor Modificadores Descrição
(construtor)(triggerResource, opções) Constrói uma nova instância da classe DocumentBuilder

Métodos

Método Modificadores Descrição
onCreate(manipulador) Responda apenas às criações de documentos.
onDelete(manipulador) Responda apenas a exclusões de documentos.
onUpdate(manipulador) Responda apenas a atualizações de documentos.
onWrite(manipulador) Responda a todas as gravações de documentos (criações, atualizações ou exclusões).

firestore.DocumentBuilder.(construtor)

Constrói uma nova instância da classe DocumentBuilder

Assinatura:

constructor(triggerResource: () => string, options: DeploymentOptions);

Parâmetros

Parâmetro Tipo Descrição
triggerResource () => string
opções Opções de implantação

firestore.DocumentBuilder.onCreate()

Responda apenas às 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
manipulador (instantâneo: QueryDocumentSnapshot , contexto: EventContext <ParamsOf<Caminho>>) => PromiseLike<qualquer> | qualquer

Retorna:

Função Cloud < 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
manipulador (instantâneo: QueryDocumentSnapshot , contexto: EventContext <ParamsOf<Caminho>>) => PromiseLike<qualquer> | qualquer

Retorna:

Função Cloud < QueryDocumentSnapshot >

firestore.DocumentBuilder.onUpdate()

Responda apenas a atualizações de documentos.

Assinatura:

onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;

Parâmetros

Parâmetro Tipo Descrição
manipulador (mudança: mudança < QueryDocumentSnapshot >, contexto: EventContext <ParamsOf<Caminho>>) => PromiseLike<qualquer> | qualquer

Retorna:

Função Cloud < Alterar < QueryDocumentSnapshot >>

firestore.DocumentBuilder.onWrite()

Responda 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
manipulador (mudança: mudança < DocumentoInstantâneo >, contexto: EventContext <ParamsOf<Caminho>>) => PromiseLike<qualquer> | qualquer

Retorna:

Função Cloud < Alterar < DocumentoInstantâneo >>