Das Firebase Installations Web SDK. Dieses SDK funktioniert nicht in einer Node.js-Umgebung.
Funktionen
Funktion | Beschreibung |
---|---|
Funktion(App, ...) | |
getInstallations(app) | Gibt eine Instanz von Installationen zurück, die der angegebenen FirebaseApp- Instanz zugeordnet sind. |
Funktion (Installationen, ...) | |
deleteInstallations(Installationen) | Löscht die Firebase-Installation und alle zugehörigen Daten. |
getId(Installationen) | Erstellt eine Firebase-Installation, falls keine für die App vorhanden ist, und gibt die Installations-ID zurück. |
getToken(Installationen, forceRefresh) | Gibt ein Firebase-Installations-Authentifizierungstoken zurück, das die aktuelle Firebase-Installation identifiziert. |
onIdChange(Installationen, Rückruf) | Legt einen neuen Rückruf fest, der aufgerufen wird, wenn sich die Installations-ID ändert. Gibt eine Abmeldefunktion zurück, die beim Aufruf den Rückruf entfernt. |
Schnittstellen
Schnittstelle | Beschreibung |
---|---|
Installationen | Öffentliche Schnittstelle des Firebase Installations SDK. |
Geben Sie Aliase ein
Geben Sie Alias ein | Beschreibung |
---|---|
IdChangeCallbackFn | Eine benutzerdefinierte Rückruffunktion, die aufgerufen wird, wenn sich die Installations-ID ändert. |
IdChangeUnsubscribeFn | Abmelden einer zuvor über IdChangeCallbackFn hinzugefügten Rückruffunktion . |
Funktion(App, ...)
getInstallations(app)
Gibt eine Instanz von Installationen zurück, die der angegebenen FirebaseApp- Instanz zugeordnet sind.
Unterschrift:
export declare function getInstallations(app?: FirebaseApp): Installations;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
App | FirebaseApp | Die FirebaseApp- Instanz. |
Kehrt zurück:
Funktion (Installationen, ...)
deleteInstallations(Installationen)
Löscht die Firebase-Installation und alle zugehörigen Daten.
Unterschrift:
export declare function deleteInstallations(installations: Installations): Promise<void>;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Installationen | Installationen | Die Installations -Instanz. |
Kehrt zurück:
Versprechen<void>
getId(Installationen)
Erstellt eine Firebase-Installation, falls keine für die App vorhanden ist, und gibt die Installations-ID zurück.
Unterschrift:
export declare function getId(installations: Installations): Promise<string>;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Installationen | Installationen | Die Installations -Instanz. |
Kehrt zurück:
Versprechen<string>
getToken(Installationen, forceRefresh)
Gibt ein Firebase-Installations-Authentifizierungstoken zurück, das die aktuelle Firebase-Installation identifiziert.
Unterschrift:
export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Installationen | Installationen | Die Installations -Instanz. |
forceRefresh | Boolescher Wert | Erzwingen Sie die Aktualisierung unabhängig vom Ablauf des Tokens. |
Kehrt zurück:
Versprechen<string>
onIdChange(Installationen, Rückruf)
Legt einen neuen Rückruf fest, der aufgerufen wird, wenn sich die Installations-ID ändert. Gibt eine Abmeldefunktion zurück, die beim Aufruf den Rückruf entfernt.
Unterschrift:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
Parameter
Parameter | Typ | Beschreibung |
---|---|---|
Installationen | Installationen | Die Installations -Instanz. |
Ruf zurück | IdChangeCallbackFn | Die Rückruffunktion, die aufgerufen wird, wenn sich die FID ändert. |
Kehrt zurück:
Eine Funktion, die zum Abbestellen aufgerufen werden kann.
IdChangeCallbackFn
Eine benutzerdefinierte Rückruffunktion, die aufgerufen wird, wenn sich die Installations-ID ändert.
Unterschrift:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdChangeUnsubscribeFn
Abmelden einer zuvor über IdChangeCallbackFn hinzugefügten Rückruffunktion .
Unterschrift:
export declare type IdChangeUnsubscribeFn = () => void;