firebase-admin.extensions package

Servicio de Extensiones de Firebase.

Funciones

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

Clases

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

Escribe alias

Alias de tipo Descripción
SettableProcessingState SettableProcessingState representa todos los estados de procesamiento que se pueden configurar en los datos del entorno de ejecución de una instancia de extensión.

getExtensions(aplicación)

Obtiene el servicio de Extensiones para la app predeterminada o una app determinada.

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App App opcional para la que se muestra el servicio Extensions Si no se proporciona, se muestra el servicio Extensions predeterminado.

Devuelve:

Extensiones

El servicio predeterminado Extensions si no se proporciona ninguna app, o bien el servicio Extensions asociado con la app 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);

SettableProcessingState

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

Puedes configurar los siguientes estados:

  • NONE: No se realizó ningún trabajo relevante de eventos de ciclo de vida. Configura esta opción para borrar los estados anteriores.

  • PROCESSING_COMPLETE: El trabajo de eventos del ciclo de vida se completó sin errores.

  • PROCESSING_WARNING: El evento del ciclo de vida se ejecutó de forma parcial o ocurrió algo sobre lo que se debe advertir al usuario.

  • PROCESSING_FAILED: No se pudo completar el trabajo de eventos del ciclo de vida, pero la instancia seguirá funcionando correctamente en el futuro.

Si la instancia de la extensión se encuentra dañada debido a errores, llama a Runtime.setFatalError().

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

Firma:

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