Firma:
export declare class DocumentBuilder<Path extends string>
Constructores
| Constructor | Modificadores | Descripción |
|---|---|---|
| (constructor)(triggerResource, opciones) | Construye una nueva instancia de la clase DocumentBuilder |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| onCreate(controlador) | Responder sólo a la creación de documentos. | |
| onDelete(controlador) | Responda únicamente a las eliminaciones de documentos. | |
| onUpdate(controlador) | Responda sólo a las actualizaciones de documentos. | |
| onWrite(controlador) | Responder a todas las escrituras de documentos (creación, actualización o eliminación). |
firestore.DocumentBuilder.(constructor)
Construye una nueva instancia de la clase DocumentBuilder
Firma:
constructor(triggerResource: () => string, options: DeploymentOptions);
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| disparadorRecurso | () => cadena | |
| opciones | Opciones de implementación |
firestore.DocumentBuilder.onCreate()
Responder sólo a la creación de documentos.
Firma:
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| manipulador | (instantánea: QueryDocumentSnapshot , contexto: EventContext <ParamsOf<Ruta>>) => PromesaComo<cualquiera> | cualquier |
Devoluciones:
Función de nube < ConsultaDocumentoInstantánea >
firestore.DocumentBuilder.onDelete()
Responda únicamente a las eliminaciones de documentos.
Firma:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| manipulador | (instantánea: QueryDocumentSnapshot , contexto: EventContext <ParamsOf<Ruta>>) => PromesaComo<cualquiera> | cualquier |
Devoluciones:
Función de nube < ConsultaDocumentoInstantánea >
firestore.DocumentBuilder.onUpdate()
Responda sólo a las actualizaciones de documentos.
Firma:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| manipulador | (cambia cambia < ConsultaDocumentoInstantánea >, contexto: EventContext <ParamsOf<Ruta>>) => PromesaComo<cualquiera> | cualquier |
Devoluciones:
Función de nube < Cambiar < ConsultaDocumentoInstantánea >>
firestore.DocumentBuilder.onWrite()
Responder a todas las escrituras de documentos (creación, actualización o eliminación).
Firma:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| manipulador | (cambia cambia < DocumentoInstantánea >, contexto: EventContext <ParamsOf<Ruta>>) => PromesaComo<cualquiera> | cualquier |
Devoluciones:
Función de nube < Cambiar < DocumentoInstantánea >>