Aplikacja Firebase
Ten pakiet koordynuje komunikację pomiędzy różnymi komponentami Firebase
Funkcje
Funkcjonować | Opis |
---|---|
funkcja (aplikacja, ...) | |
usuń aplikację (aplikację) | Powoduje, że ta aplikacja staje się bezużyteczna i zwalnia zasoby wszystkich powiązanych usług. |
funkcjonować() | |
pobierzAplikacje() | Tablica (tylko do odczytu) zawierająca wszystkie zainicjowane aplikacje. |
zainicjuj aplikację() | Tworzy i inicjuje instancję FirebaseApp. |
funkcja(libraryKeyOrName, ...) | |
RegisterVersion(libraryKeyOrName, wersja, wariant) | Rejestruje nazwę i wersję biblioteki na potrzeby rejestrowania platformy. |
funkcja(logCallback, ...) | |
onLog(logCallback, opcje) | Ustawia procedurę obsługi dziennika dla wszystkich zestawów SDK Firebase. |
funkcja(logLevel, ...) | |
setLogLevel(logLevel) | Ustawia poziom dziennika dla wszystkich zestawów SDK Firebase. Przechwytywane są wszystkie typy dzienników powyżej bieżącego poziomu dziennika (tzn. jeśli ustawisz poziom dziennika na info , rejestrowane będą błędy, ale dzienniki debug i verbose nie są rejestrowane). |
funkcja(nazwa, ...) | |
pobierzAplikację(nazwa) | Pobiera instancję FirebaseApp . Po wywołaniu bez argumentów zwracana jest domyślna aplikacja. Po podaniu nazwy aplikacji zwracana jest aplikacja odpowiadająca tej nazwie. Jeśli pobierana aplikacja nie została jeszcze zainicjowana, zgłaszany jest wyjątek. |
funkcja(opcje, ...) | |
zainicjujAplikację(opcje, nazwa) | Tworzy i inicjuje instancję FirebaseApp . Aby uzyskać szczegółową dokumentację, zobacz Dodawanie Firebase do swojej aplikacji i Inicjowanie wielu projektów . |
zainicjujAplikację(opcje, konfiguracja) | Tworzy i inicjuje instancję FirebaseApp. |
Interfejsy
Interfejs | Opis |
---|---|
Aplikacja Firebase | Aplikacja FirebaseApp przechowuje informacje inicjujące dla zbioru usług. Nie wywołuj tego konstruktora bezpośrednio. Zamiast tego użyj inicjalizacjiApp() , aby utworzyć aplikację. |
Ustawienia aplikacji Firebase | Opcje konfiguracji podane dla zainicjowaniaApp() |
Opcje Firebase | Obiekt konfiguracyjny Firebase. Zawiera zestaw parametrów wymaganych przez usługi w celu pomyślnej komunikacji z interfejsami API serwera Firebase i powiązania danych klienta z projektem Firebase i aplikacją Firebase. Zazwyczaj ten obiekt jest wypełniany przez konsolę Firebase podczas konfiguracji projektu. Zobacz także: Dowiedz się o obiekcie konfiguracyjnym Firebase . |
Zmienne
Zmienny | Opis |
---|---|
SDK_WERSJA | Bieżąca wersja SDK. |
funkcja (aplikacja, ...)
usuń aplikację (aplikację)
Powoduje, że ta aplikacja staje się bezużyteczna i zwalnia zasoby wszystkich powiązanych usług.
Podpis:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja Firebase |
Zwroty:
Obietnica<pusta>
Przykład
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
funkcjonować()
pobierzAplikacje()
Tablica (tylko do odczytu) zawierająca wszystkie zainicjowane aplikacje.
Podpis:
export declare function getApps(): FirebaseApp[];
Zwroty:
zainicjuj aplikację()
Tworzy i inicjuje instancję FirebaseApp.
Podpis:
export declare function initializeApp(): FirebaseApp;
Zwroty:
funkcja(libraryKeyOrName, ...)
RegisterVersion(libraryKeyOrName, wersja, wariant)
Rejestruje nazwę i wersję biblioteki na potrzeby rejestrowania platformy.
Podpis:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
bibliotekaKeyOrName | strunowy | |
wersja | strunowy | Aktualna wersja tej biblioteki. |
wariant | strunowy | Wariant pakietu, np. węzeł, rn itp. |
Zwroty:
próżnia
funkcja(logCallback, ...)
onLog(logCallback, opcje)
Ustawia procedurę obsługi dziennika dla wszystkich zestawów SDK Firebase.
Podpis:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
logCallback | LogCallback | zero | Opcjonalna niestandardowa procedura obsługi dziennika, która wykonuje kod użytkownika za każdym razem, gdy zestaw SDK Firebase wykonuje wywołanie rejestrowania. |
opcje | Opcje dziennika |
Zwroty:
próżnia
funkcja(logLevel, ...)
setLogLevel(logLevel)
Ustawia poziom dziennika dla wszystkich zestawów SDK Firebase.
Przechwytywane są wszystkie typy dzienników powyżej bieżącego poziomu rejestrowania (tzn. jeśli ustawisz poziom rejestrowania na info
, rejestrowane są błędy, ale dzienniki debug
i verbose
nie są).
Podpis:
export declare function setLogLevel(logLevel: LogLevelString): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
poziom dziennika | LogLevelString |
Zwroty:
próżnia
funkcja(nazwa, ...)
pobierzAplikację(nazwa)
Pobiera instancję FirebaseApp .
Po wywołaniu bez argumentów zwracana jest domyślna aplikacja. Po podaniu nazwy aplikacji zwracana jest aplikacja odpowiadająca tej nazwie.
Jeśli pobierana aplikacja nie została jeszcze zainicjowana, zgłaszany jest wyjątek.
Podpis:
export declare function getApp(name?: string): FirebaseApp;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Opcjonalna nazwa aplikacji do zwrócenia. Jeśli nie podano nazwy, wartością domyślną jest "[DEFAULT]" . |
Zwroty:
Aplikacja odpowiadająca podanej nazwie aplikacji. Jeśli nie podano nazwy aplikacji, zwracana jest aplikacja domyślna.
Przykład 1
// Return the default app
const app = getApp();
Przykład 2
// Return a named app
const otherApp = getApp("otherApp");
funkcja(opcje, ...)
zainicjujAplikację(opcje, nazwa)
Tworzy i inicjuje instancję FirebaseApp .
Aby uzyskać szczegółową dokumentację, zobacz Dodawanie Firebase do swojej aplikacji i Inicjowanie wielu projektów .
Podpis:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Opcje Firebase | Opcje konfiguracji usług aplikacji. |
nazwa | strunowy | Opcjonalna nazwa aplikacji do zainicjowania. Jeśli nie podano nazwy, wartością domyślną jest "[DEFAULT]" . |
Zwroty:
Zainicjowana aplikacja.
Przykład 1
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
Przykład 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
zainicjujAplikację(opcje, konfiguracja)
Tworzy i inicjuje instancję FirebaseApp.
Podpis:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Opcje Firebase | Opcje konfiguracji usług aplikacji. |
konfiguracja | Ustawienia aplikacji Firebase | Konfiguracja aplikacji Firebase |
Zwroty:
SDK_WERSJA
Bieżąca wersja SDK.
Podpis:
SDK_VERSION: string