App Firebase
Questo pacchetto coordina la comunicazione tra i diversi componenti di Firebase
Funzioni
| Funzione | Descrizione |
|---|---|
| function(app, ...) | |
| deleteApp(app) | Rende inutilizzabile questa app e libera le risorse di tutti i servizi associati. |
| funzione (()) | |
| getApps() | Un array (sola lettura) di tutte le app inizializzate. |
| initializeApp() | Crea e inizializza un'istanza FirebaseApp. |
| function(libraryKeyOrName, ...) | |
| registerVersion(libraryKeyOrName, version, variant) | Registra il nome e la versione di una libreria ai fini del logging della piattaforma. |
| function(logCallback, ...) | |
| onLog(logCallback, opzioni) | Imposta il gestore di log per tutti gli SDK Firebase. |
| function(logLevel, ...) | |
| setLogLevel(logLevel) | Imposta il livello di log per tutti gli SDK Firebase.Vengono acquisiti tutti i tipi di log superiori al livello di log attuale (ad esempio, se imposti il livello di log su info, vengono registrati gli errori, ma non i log debug e verbose). |
| funzione(nome, ...) | |
| getApp(name) | Recupera un'istanza FirebaseApp.Quando chiamata senza argomenti, viene restituita l'app predefinita. Quando viene fornito il nome di un'app, viene restituita l'app corrispondente.Viene generata un'eccezione se l'app in fase di recupero non è stata ancora inizializzata. |
| funzione(opzioni, ...) | |
| initializeApp(opzioni, nome) | Crea e inizializza un'istanza FirebaseApp.Consulta Aggiungere Firebase all'app e Inizializzare più progetti per la documentazione dettagliata. |
| initializeApp(opzioni, configurazione) | Crea e inizializza un'istanza FirebaseApp. |
| initializeServerApp(opzioni, configurazione) | Crea e inizializza un'istanza FirebaseServerApp.FirebaseServerApp è simile a FirebaseApp, ma è destinato all'esecuzione solo in ambienti di rendering lato server. L'inizializzazione non riuscirà se richiamata da un ambiente browser.Per la documentazione dettagliata, consulta Aggiungere Firebase all'app e Inizializzare più progetti. |
Interfacce
| Interfaccia | Descrizione |
|---|---|
| FirebaseApp | FirebaseApp contiene le informazioni di inizializzazione per una raccolta di servizi.Non chiamare direttamente questo costruttore. Utilizza invece initializeApp() per creare un'app. |
| FirebaseAppSettings | Opzioni di configurazione fornite per initializeApp() |
| FirebaseOptions | Oggetto di configurazione Firebase. Contiene un insieme di parametri richiesti dai servizi per comunicare correttamente con le API dei server Firebase e associare i dati client al progetto Firebase e all'applicazione Firebase. In genere questo oggetto viene completato dalla console Firebase durante la configurazione del progetto. Vedi anche: Informazioni sull'oggetto di configurazione Firebase. |
| FirebaseServerApp | FirebaseServerApp contiene le informazioni di inizializzazione per una raccolta di servizi in esecuzione in ambienti server.Non chiamare direttamente questo costruttore. Utilizza invece initializeServerApp() per creare un'app. |
| FirebaseServerAppSettings | Opzioni di configurazione fornite per initializeServerApp() |
Variabili
| Variabile | Descrizione |
|---|---|
| SDK_VERSION | La versione corrente dell'SDK. |
funzione(app, ...)
deleteApp(app)
Rende inutilizzabile questa app e libera le risorse di tutti i servizi associati.
Firma:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| app | FirebaseApp |
Resi:
Promise<void>
Esempio
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
funzione()
getApps()
Un array (sola lettura) di tutte le app inizializzate.
Firma:
export declare function getApps(): FirebaseApp[];
Resi:
initializeApp()
Crea e inizializza un'istanza FirebaseApp.
Firma:
export declare function initializeApp(): FirebaseApp;
Resi:
funzione(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
Registra il nome e la versione di una libreria ai fini del logging della piattaforma.
Firma:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| libraryKeyOrName | stringa | |
| versione | stringa | La versione corrente della libreria. |
| variante | stringa | Variante bundle, ad es. node, rn e così via. |
Resi:
void
funzione(logCallback, ...)
onLog(logCallback, opzioni)
Imposta il gestore di log per tutti gli SDK Firebase.
Firma:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| logCallback | Registra callback | null | Gestore di log personalizzato facoltativo che esegue il codice utente ogni volta che l'SDK Firebase effettua una chiamata di logging. |
| opzioni del modello. | LogOptions |
Resi:
void
funzione(logLevel, ...)
setLogLevel(logLevel)
Imposta il livello di log per tutti gli SDK Firebase.
Vengono acquisiti tutti i tipi di log superiori al livello di log attuale (ad esempio, se imposti il livello di log su info, vengono registrati gli errori, ma non i log debug e verbose).
Firma:
export declare function setLogLevel(logLevel: LogLevelString): void;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| logLevel | LogLevelString |
Resi:
void
funzione(nome, ...)
getApp(nome)
Recupera un'istanza FirebaseApp.
Quando chiamata senza argomenti, viene restituita l'app predefinita. Quando viene fornito il nome di un'app, viene restituita l'app corrispondente.
Viene generata un'eccezione se l'app in fase di recupero non è ancora stata inizializzata.
Firma:
export declare function getApp(name?: string): FirebaseApp;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome | stringa | Nome facoltativo dell'app da restituire. Se non viene fornito alcun nome, il valore predefinito è "[DEFAULT]". |
Resi:
L'app corrispondente al nome dell'app fornito. Se non viene fornito alcun nome dell'app, viene restituita l'app predefinita.
Esempio 1
// Return the default app
const app = getApp();
Esempio 2
// Return a named app
const otherApp = getApp("otherApp");
funzione(opzioni, ...)
startizeApp(opzioni; nome)
Crea e inizializza un'istanza FirebaseApp.
Per una documentazione dettagliata, consulta gli articoli Aggiungere Firebase alla tua app e Inizializzare più progetti.
Firma:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| opzioni del modello. | FirebaseOptions | Opzioni per configurare i servizi dell'app. |
| nome | stringa | Nome facoltativo dell'app da inizializzare. Se non viene fornito alcun nome, il valore predefinito è "[DEFAULT]". |
Resi:
L'app inizializzata.
Esempio 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
});
Esempio 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
startizeApp(opzioni, configurazione)
Crea e inizializza un'istanza FirebaseApp.
Firma:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| opzioni del modello. | FirebaseOptions | Opzioni per configurare i servizi dell'app. |
| config | FirebaseAppSettings | Configurazione FirebaseApp |
Resi:
inizializzaizeServerApp(opzioni, configurazione)
Crea e inizializza un'istanza FirebaseServerApp.
FirebaseServerApp è simile a FirebaseApp, ma è destinato all'esecuzione solo in ambienti di rendering lato server. L'inizializzazione non riuscirà se richiamata da un ambiente browser.
Per una documentazione dettagliata, consulta gli articoli Aggiungere Firebase alla tua app e Inizializzare più progetti.
Firma:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| opzioni del modello. | FirebaseOptions | FirebaseApp | Firebase.AppOptions per configurare i servizi dell'app o un'istanza FirebaseApp contenente il AppOptions al suo interno. |
| config | FirebaseServerAppSettings | Configurazione di FirebaseServerApp. |
Resi:
Il valore FirebaseServerApp inizializzato.
Esempio
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
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
},
{
authIdToken: "Your Auth ID Token"
});
SDK_VERSION
La versione corrente dell'SDK.
Firma:
SDK_VERSION: string