installations package

Le SDK Web des installations Firebase. Ce SDK ne fonctionne pas dans un environnement Node.js.

Les fonctions

Fonction Description
fonction(application, ...)
obtenirInstallations (application) Renvoie une instance d' installations associée à l'instance FirebaseApp donnée.
fonction(installations, ...)
supprimerInstallations(installations) Supprime l'installation de Firebase et toutes les données associées.
getId (installations) Crée une installation Firebase s'il n'y en a pas pour l'application et renvoie l'ID d'installation.
getToken (installations, forceRefresh) Renvoie un jeton d'authentification des installations Firebase, identifiant l'installation Firebase actuelle.
onIdChange (installations, rappel) Définit un nouveau rappel qui sera appelé lorsque l'ID d'installation change. Renvoie une fonction de désabonnement qui supprimera le rappel lorsqu'il est appelé.

Interfaces

Interface Description
Installations Interface publique du SDK d'installations Firebase.

Tapez les alias

Tapez l'alias Description
IdChangeCallbackFn Une fonction de rappel définie par l'utilisateur qui est appelée lorsque l'ID d'installation change.
IdChangeUnsubscribeFn Désinscrire une fonction de rappel précédemment ajoutée via IdChangeCallbackFn .

fonction(application, ...)

obtenirInstallations (application)

Renvoie une instance d' installations associée à l'instance FirebaseApp donnée.

Signature:

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

Paramètres

Paramètre Taper Description
application FirebaseApp L'instance FirebaseApp .

Retour:

Installations

fonction(installations, ...)

supprimerInstallations(installations)

Supprime l'installation de Firebase et toutes les données associées.

Signature:

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

Paramètres

Paramètre Taper Description
installation Installations L'instance Installations .

Retour:

Promesse<vide>

getId (installations)

Crée une installation Firebase s'il n'y en a pas pour l'application et renvoie l'ID d'installation.

Signature:

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

Paramètres

Paramètre Taper Description
installation Installations L'instance Installations .

Retour:

Promesse<string>

getToken (installations, forceRefresh)

Renvoie un jeton d'authentification des installations Firebase, identifiant l'installation Firebase actuelle.

Signature:

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

Paramètres

Paramètre Taper Description
installation Installations L'instance Installations .
forceActualiser booléen Forcer l’actualisation quelle que soit l’expiration du jeton.

Retour:

Promesse<string>

onIdChange (installations, rappel)

Définit un nouveau rappel qui sera appelé lorsque l'ID d'installation change. Renvoie une fonction de désabonnement qui supprimera le rappel lorsqu'il est appelé.

Signature:

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

Paramètres

Paramètre Taper Description
installation Installations L'instance Installations .
rappeler IdChangeCallbackFn Fonction de rappel invoquée lorsque le FID change.

Retour:

IdChangeUnsubscribeFn

Une fonction qui peut être appelée pour se désinscrire.

IdChangeCallbackFn

Une fonction de rappel définie par l'utilisateur qui est appelée lorsque l'ID d'installation change.

Signature:

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

IdChangeUnsubscribeFn

Désinscrire une fonction de rappel précédemment ajoutée via IdChangeCallbackFn .

Signature:

export declare type IdChangeUnsubscribeFn = () => void;