installations package

El SDK web de instalaciones de Firebase. Este SDK no funciona en un entorno Node.js.

Funciones

Función Descripción
función (aplicación, ...)
obtenerInstalaciones(aplicación) Devuelve una instancia de instalaciones asociadas con la instancia de FirebaseApp determinada.
función(instalaciones, ...)
eliminarInstalaciones(instalaciones) Elimina la instalación de Firebase y todos los datos asociados.
getId(instalaciones) Crea una instalación de Firebase si no hay una para la aplicación y devuelve el ID de instalación.
getToken(instalaciones, forceRefresh) Devuelve un token de autenticación de instalaciones de Firebase, que identifica la instalación de Firebase actual.
onIdChange(instalaciones, devolución de llamada) Establece una nueva devolución de llamada que se llamará cuando cambie el ID de instalación. Devuelve una función para cancelar la suscripción que eliminará la devolución de llamada cuando se llame.

Interfaces

Interfaz Descripción
Instalaciones Interfaz pública del SDK de instalaciones de Firebase.

Tipo de alias

Tipo Alias Descripción
IdCambiarDevoluciónDeLlamadaFn Una función de devolución de llamada definida por el usuario que se llama cuando cambia el ID de instalación.
IdCambiarCancelar suscripciónFn Cancelar la suscripción de una función de devolución de llamada agregada previamente a través de IdChangeCallbackFn .

función (aplicación, ...)

obtenerInstalaciones(aplicación)

Devuelve una instancia de instalaciones asociadas con la instancia de FirebaseApp determinada.

Firma:

export declare function getInstallations(app?: FirebaseApp): Installations;

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La instancia de FirebaseApp .

Devoluciones:

Instalaciones

función(instalaciones, ...)

eliminarInstalaciones(instalaciones)

Elimina la instalación de Firebase y todos los datos asociados.

Firma:

export declare function deleteInstallations(installations: Installations): Promise<void>;

Parámetros

Parámetro Tipo Descripción
instalaciones Instalaciones La instancia Installations .

Devoluciones:

Promesa<nulo>

getId(instalaciones)

Crea una instalación de Firebase si no hay una para la aplicación y devuelve el ID de instalación.

Firma:

export declare function getId(installations: Installations): Promise<string>;

Parámetros

Parámetro Tipo Descripción
instalaciones Instalaciones La instancia Installations .

Devoluciones:

Promesa<cadena>

getToken(instalaciones, forceRefresh)

Devuelve un token de autenticación de instalaciones de Firebase, que identifica la instalación de Firebase actual.

Firma:

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

Parámetros

Parámetro Tipo Descripción
instalaciones Instalaciones La instancia Installations .
forceRefresh booleano Forzar la actualización independientemente de la caducidad del token.

Devoluciones:

Promesa<cadena>

onIdChange(instalaciones, devolución de llamada)

Establece una nueva devolución de llamada que se llamará cuando cambie el ID de instalación. Devuelve una función para cancelar la suscripción que eliminará la devolución de llamada cuando se llame.

Firma:

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

Parámetros

Parámetro Tipo Descripción
instalaciones Instalaciones La instancia Installations .
llamar de vuelta IdCambiarDevoluciónDeLlamadaFn La función de devolución de llamada que se invoca cuando cambia el FID.

Devoluciones:

IdCambiarCancelar suscripciónFn

Una función a la que se puede llamar para cancelar la suscripción.

IdCambiarDevoluciónDeLlamadaFn

Una función de devolución de llamada definida por el usuario que se llama cuando cambia el ID de instalación.

Firma:

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdCambiarCancelar suscripciónFn

Cancelar la suscripción de una función de devolución de llamada agregada previamente a través de IdChangeCallbackFn .

Firma:

export declare type IdChangeUnsubscribeFn = () => void;