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...) | |
getInstalaciones (aplicación) | Devuelve una instancia de Instalaciones asociadas con la instancia de FirebaseApp dada. |
función(instalaciones...) | |
deleteInstalaciones(instalaciones) | Elimina la instalación de Firebase y todos los datos asociados. |
getId(instalaciones) | Crea una instalación de Firebase si no hay ninguna para la aplicación y devuelve el ID de instalación. |
getToken(instalaciones, forceRefresh) | Devuelve un token de autenticación de las 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 de cancelación de 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
Alias de tipo | Descripción |
---|---|
IdChangeCallbackFn | Una función de devolución de llamada definida por el usuario que se llama cuando cambia el ID de instalación. |
IdChangeUnsubscribeFn | Darse de baja de una función de devolución de llamada agregada previamente a través de IdChangeCallbackFn . |
getInstalaciones()
Devuelve una instancia de Instalaciones asociadas con la instancia de FirebaseApp dada.
Firma:
export declare function getInstallations(app?: FirebaseApp): Installations;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
aplicación | FirebaseApp | La instancia de FirebaseApp . |
Devoluciones:
eliminarInstalaciones()
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 <vacío>
obtenerId()
Crea una instalación de Firebase si no hay ninguna 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>
obtenerToken()
Devuelve un token de autenticación de las 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()
Establece una nueva devolución de llamada que se llamará cuando cambie el ID de instalación. Devuelve una función de cancelación de 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 | IdChangeCallbackFn | La función de devolución de llamada que se invoca cuando cambia FID. |
Devoluciones:
Una función que se puede llamar para darse de baja.
IdChangeCallbackFn
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;
IdChangeUnsubscribeFn
Darse de baja de una función de devolución de llamada agregada previamente a través de IdChangeCallbackFn .
Firma:
export declare type IdChangeUnsubscribeFn = () => void;