firebase-admin.extensions package

Servicio de extensiones de Firebase.

Funciones

Función Descripción
obtenerExtensiones(aplicación) Obtiene el servicio Extensiones para la aplicación predeterminada o una aplicación determinada. Se puede llamar getExtensions() sin argumentos para acceder al servicio Extensions de la aplicación predeterminada o como getExtensions(app) para acceder al servicio Extensions asociado con una aplicación específica.

Clases

Clase Descripción
Extensiones La interfaz del servicio Firebase Extensions .
Tiempo de ejecución Runtime proporciona métodos para modificar los datos de tiempo de ejecución de una instancia de extensión.

Tipo de alias

Tipo Alias Descripción
Estado de procesamiento configurable SettableProcessingState representa todos los estados de procesamiento que se pueden configurar en los datos de tiempo de ejecución de una instancia de extensión.

obtenerExtensiones()

Obtiene el servicio Extensiones para la aplicación predeterminada o una aplicación determinada.

Se puede llamar getExtensions() sin argumentos para acceder al servicio Extensions de la aplicación predeterminada o como getExtensions(app) para acceder al servicio Extensions asociado con una aplicación específica.

Firma:

export declare function getExtensions(app?: App): Extensions;

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación App opcional para devolver el servicio Extensions . Si no se proporciona, se devuelve el servicio Extensions predeterminado.

Devoluciones:

Extensiones

El servicio Extensions predeterminado si no se proporciona ninguna aplicación, o el servicio Extensions asociado con la aplicación proporcionada.

Ejemplo 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Ejemplo 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

Estado de procesamiento configurable

SettableProcessingState representa todos los estados de procesamiento que se pueden configurar en los datos de tiempo de ejecución de una instancia de extensión.

Puede configurar los siguientes estados:

  • NONE : No se ha realizado ningún trabajo relevante sobre eventos del ciclo de vida. Configúrelo para borrar estados antiguos.

  • PROCESSING_COMPLETE : Trabajo del evento del ciclo de vida completado sin errores.

  • PROCESSING_WARNING : El trabajo del evento del ciclo de vida se realizó parcialmente o sucedió algo sobre lo que se debe advertir al usuario.

  • PROCESSING_FAILED : El trabajo del evento del ciclo de vida falló por completo, pero la instancia seguirá funcionando correctamente en el futuro.

Si la instancia de extensión está en un estado roto debido a errores, llame a Runtime.setFatalError() .

El estado de "procesamiento" se establece automáticamente cuando se inicia un controlador de eventos del ciclo de vida; no puedes configurarlo explícitamente. Para informar el estado actual de la función de una extensión, use console.log o el SDK del registrador de Cloud Functions.

Firma:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';