Internetowy pakiet SDK instalacji Firebase. Ten pakiet SDK nie działa w środowisku Node.js.
Funkcje
| Funkcja | Opis |
|---|---|
| function(aplikacja, ...) | |
| getinstalls(aplikacja) | Zwraca wystąpienie Instalacje powiązane z podaną instancją FirebaseApp. |
| funkcje(instalacje, ...) | |
| deleteinstalls(instalacje) | Usuwa instalację Firebase i wszystkie powiązane dane. |
| getId(instalacje) | Tworzy instalację Firebase, jeśli nie ma takiej instalacji dla aplikacji i zwraca identyfikator instalacji. |
| getToken(instalacje, forceRefresh) | Zwraca token uwierzytelniania instalacji Firebase identyfikujący bieżącą instalację Firebase. |
| onIdChange(instalacje, wywołanie zwrotne) | Ustawia nowe wywołanie zwrotne, które będzie wywoływane po zmianie identyfikatora instalacji. Zwraca funkcję anulowania subskrypcji, która usuwa wywołanie zwrotne po wywołaniu. |
Interfejsy
| Interfejs | Opis |
|---|---|
| Instalacje | Publiczny interfejs pakietu SDK instalacji Firebase. |
Aliasy typu
| Wpisz alias | Opis |
|---|---|
| IdChangeCallbackFn | Zdefiniowana przez użytkownika funkcja wywołania zwrotnego, która jest wywoływana po zmianie identyfikatora instalacji. |
| IdChangeUnsubscribeFn. | Anuluj subskrypcję funkcji wywołania zwrotnego dodanej wcześniej przez IdChangeCallbackFn. |
funkcja(aplikacja, ...)
getinstalls(aplikacja)
Zwraca wystąpienie Instalacje powiązane z podaną instancją FirebaseApp.
Podpis:
export declare function getInstallations(app?: FirebaseApp): Installations;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja Firebase | Instancja FirebaseApp. |
Zwroty:
funkcja(instalacje, ...)
deleteinstalls(instalacje)
Usuwa instalację Firebase i wszystkie powiązane dane.
Podpis:
export declare function deleteInstallations(installations: Installations): Promise<void>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| instalacje | Instalacje | Instancja Installations. |
Zwroty:
Obietnica<void>
getId(instalacje)
Tworzy instalację Firebase, jeśli nie ma takiej instalacji dla aplikacji i zwraca identyfikator instalacji.
Podpis:
export declare function getId(installations: Installations): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| instalacje | Instalacje | Instancja Installations. |
Zwroty:
Obietnica<ciąg>
getToken(instalacje, forceRefresh)
Zwraca token uwierzytelniania instalacji Firebase identyfikujący bieżącą instalację Firebase.
Podpis:
export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| instalacje | Instalacje | Instancja Installations. |
| wymuszanie odświeżania | wartość logiczna | Wymuszaj odświeżanie niezależnie od daty wygaśnięcia tokena. |
Zwroty:
Obietnica<ciąg>
onIdChange(instalacje, wywołanie zwrotne)
Ustawia nowe wywołanie zwrotne, które będzie wywoływane po zmianie identyfikatora instalacji. Zwraca funkcję anulowania subskrypcji, która usuwa wywołanie zwrotne po wywołaniu.
Podpis:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| instalacje | Instalacje | Instancja Installations. |
| wywołanie zwrotne | IdChangeCallbackFn | Funkcja wywołania zwrotnego, która jest wywoływana po zmianie FID. |
Zwroty:
Funkcja, którą można wywołać w celu anulowania subskrypcji.
IdChangeCallbackFn
Zdefiniowana przez użytkownika funkcja wywołania zwrotnego, która jest wywoływana po zmianie identyfikatora instalacji.
Podpis:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdChangeUnsubscribeFn.
Anuluj subskrypcję funkcji wywołania zwrotnego dodanej wcześniej przez IdChangeCallbackFn.
Podpis:
export declare type IdChangeUnsubscribeFn = () => void;