Internetowy zestaw SDK instalacji Firebase. Ten zestaw SDK nie działa w środowisku Node.js.
Funkcje
Funkcjonować | Opis |
---|---|
funkcja (aplikacja, ...) | |
pobierzInstalacje(aplikacja) | Zwraca instancję instalacji powiązaną z daną instancją FirebaseApp . |
funkcja(instalacje, ...) | |
usuńInstalacje(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, wymuszenie odświeżania) | Zwraca token autoryzacji instalacji Firebase, identyfikujący bieżącą instalację Firebase. |
onIdChange (instalacje, wywołanie zwrotne) | Ustawia nowe wywołanie zwrotne, które zostanie wywołane w przypadku zmiany identyfikatora instalacji. Zwraca funkcję anulowania subskrypcji, która po wywołaniu usunie wywołanie zwrotne. |
Interfejsy
Interfejs | Opis |
---|---|
Instalacje | Publiczny interfejs pakietu SDK Instalacji Firebase. |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
IdChangeCallbackFn | Zdefiniowana przez użytkownika funkcja wywołania zwrotnego, która jest wywoływana w przypadku zmiany identyfikatora instalacji. |
IdZmieńAnuluj subskrypcjęFn | Anuluj subskrypcję funkcji wywołania zwrotnego dodanej wcześniej za pomocą IdChangeCallbackFn . |
funkcja (aplikacja, ...)
pobierzInstalacje(aplikacja)
Zwraca instancję instalacji powiązaną z daną instancją FirebaseApp .
Podpis:
export declare function getInstallations(app?: FirebaseApp): Installations;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja Firebase | Instancja FirebaseApp . |
Zwroty:
funkcja(instalacje, ...)
usuńInstalacje(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<pusta>
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<string>
getToken(instalacje, wymuszenie odświeżania)
Zwraca token autoryzacji 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 . |
wymuśOdśwież | wartość logiczna | Wymuś odświeżenie niezależnie od wygaśnięcia tokenu. |
Zwroty:
Obietnica<string>
onIdChange (instalacje, wywołanie zwrotne)
Ustawia nowe wywołanie zwrotne, które zostanie wywołane w przypadku zmiany identyfikatora instalacji. Zwraca funkcję anulowania subskrypcji, która po wywołaniu usunie wywołanie zwrotne.
Podpis:
export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
Parametry
Parametr | Typ | Opis |
---|---|---|
instalacje | Instalacje | Instancja Installations . |
oddzwonić | IdChangeCallbackFn | Funkcja wywołania zwrotnego wywoływana w przypadku zmiany FID. |
Zwroty:
Funkcja, którą można wywołać w celu wypisania się.
IdChangeCallbackFn
Zdefiniowana przez użytkownika funkcja wywołania zwrotnego, która jest wywoływana w przypadku zmiany identyfikatora instalacji.
Podpis:
export declare type IdChangeCallbackFn = (installationId: string) => void;
IdZmieńAnuluj subskrypcjęFn
Anuluj subskrypcję funkcji wywołania zwrotnego dodanej wcześniej za pomocą IdChangeCallbackFn .
Podpis:
export declare type IdChangeUnsubscribeFn = () => void;