installations package

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

Funciones

Función Descripción
function(app, ...)
getInstallations(app) Muestra una instancia de Installations asociada con la instancia de FirebaseApp determinada.
function(instalaciones, etc.)
deleteInstallations(instalaciones) Borra la instalación de Firebase y todos los datos asociados.
getId(instalaciones) Crea una instalación de Firebase si no hay una para la app y muestra 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 a la que se llamará cuando cambie el ID de instalación. Muestra una función de anulación de suscripción que quitará la devolución de llamada cuando se la llame.

Interfaces

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

Escribe alias

Alias de tipo Descripción
IdChangeCallbackFn Una función de devolución de llamada definida por el usuario a la que se llama cuando cambia el ID de instalaciones.
IdChangeSubscriptionFn Anula la suscripción de una función de devolución de llamada que se agregó anteriormente a través de IdChangeCallbackFn.

función(app, ...)

getInstallations(app)

Muestra una instancia de Installations asociada con la instancia de FirebaseApp determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App de Firebase La instancia FirebaseApp.

Muestra:

Instalaciones

función(instalaciones, ...)

deleteInstallations(instalaciones)

Borra 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

Muestra:

Promesa<void>

getId(instalaciones)

Crea una instalación de Firebase si no hay una para la app y muestra 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

Muestra:

Promesa<string>

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
forzar la actualización booleano Fuerza la actualización sin importar el vencimiento del token.

Muestra:

Promesa<string>

onIdChange(instalaciones, devolución de llamada)

Establece una nueva devolución de llamada a la que se llamará cuando cambie el ID de instalación. Muestra una función de anulación de suscripción que quitará la devolución de llamada cuando se la llame.

Firma:

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

Parámetros

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

Muestra:

IdChangeSubscriptionFn

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

IdChangeCallbackFn

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

Firma:

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

IdChangeAnular la suscripción

Anula la suscripción de una función de devolución de llamada que se agregó anteriormente a través de IdChangeCallbackFn.

Firma:

export declare type IdChangeUnsubscribeFn = () => void;