Aplikasi Firebase
Paket ini mengoordinasikan komunikasi antara berbagai komponen Firebase
Functions
| Fungsi | Deskripsi |
|---|---|
| fungsi(aplikasi, ...) | |
| deleteApp(aplikasi) | Membuat aplikasi ini tidak dapat digunakan dan membebaskan resource semua layanan terkait. |
| function() | |
| getApps() | Array (hanya baca) dari semua aplikasi yang diinisialisasi. |
| InitializeApp() | Membuat dan melakukan inisialisasi instance FirebaseApp. |
| function(libraryKeyOrName, ...) | |
| registerVersion(libraryKeyOrName, versi, varian) | Mendaftarkan nama dan versi library untuk tujuan logging platform. |
| function(logCallback, ...) | |
| onLog(logCallback, opsi) | Menetapkan pengendali log untuk semua Firebase SDK. |
| function(logLevel, ...) | |
| setLogLevel(logLevel) | Menetapkan level log untuk semua Firebase SDK.Semua jenis log di atas level log saat ini akan direkam (artinya, jika Anda menetapkan level log ke info, error akan dicatat, tetapi log debug dan verbose tidak akan dicatat). |
| fungsi(nama, ...) | |
| getApp(nama) | Mengambil instance FirebaseApp.Saat dipanggil tanpa argumen, aplikasi default akan ditampilkan. Jika nama aplikasi diberikan, aplikasi yang sesuai dengan nama tersebut akan ditampilkan.Pengecualian dilempar jika aplikasi yang diambil belum diinisialisasi. |
| fungsi(opsi, ...) | |
| inisialisasiApp(opsi, nama) | Membuat dan melakukan inisialisasi instance FirebaseApp.Lihat Menambahkan Firebase ke aplikasi Anda dan Melakukan inisialisasi beberapa project untuk dokumentasi mendetail. |
| inisialisasiApp(opsi, konfigurasi) | Membuat dan melakukan inisialisasi instance FirebaseApp. |
| InitializeServerApp(opsi, konfigurasi) | Membuat dan melakukan inisialisasi instance FirebaseServerApp.FirebaseServerApp mirip dengan FirebaseApp, tetapi hanya ditujukan untuk eksekusi di lingkungan rendering sisi server. Inisialisasi akan gagal jika dipanggil dari lingkungan browser.Lihat Menambahkan Firebase ke aplikasi Anda dan Melakukan inisialisasi beberapa project untuk dokumentasi mendetail. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| AplikasiFirebase | FirebaseApp menyimpan informasi inisialisasi untuk sekumpulan layanan.Jangan panggil konstruktor ini secara langsung. Sebagai gantinya, gunakan InitializeApp() untuk membuat aplikasi. |
| FirebaseAppSettings | Opsi konfigurasi yang diberikan ke InitializeApp() |
| FirebaseOptions | Objek konfigurasi Firebase. Berisi kumpulan parameter yang diperlukan oleh layanan agar berhasil berkomunikasi dengan API server Firebase dan untuk mengaitkan data klien dengan project Firebase dan aplikasi Firebase Anda. Biasanya, objek ini diisi oleh Firebase console saat penyiapan project. Lihat juga: Mempelajari objek konfigurasi Firebase. |
| FirebaseServerApp | FirebaseServerApp menyimpan informasi inisialisasi untuk kumpulan layanan yang berjalan di lingkungan server.Jangan panggil konstruktor ini secara langsung. Sebagai gantinya, gunakan InitializeServerApp() untuk membuat aplikasi. |
| FirebaseServerAppSettings | Opsi konfigurasi yang diberikan ke InitializeServerApp() |
Variabel
| Variabel | Deskripsi |
|---|---|
| Versi_SDK | Versi SDK saat ini. |
function(aplikasi, ...)
deleteApp(aplikasi)
Membuat aplikasi ini tidak dapat digunakan dan membebaskan resource semua layanan terkait.
Tanda Tangan:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| aplikasi | AplikasiFirebase |
Hasil:
Janji<void>
Contoh
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
function()
getApps()
Array (hanya baca) dari semua aplikasi yang diinisialisasi.
Tanda Tangan:
export declare function getApps(): FirebaseApp[];
Hasil:
inisialisasiApp()
Membuat dan menginisialisasi instance FirebaseApp.
Tanda Tangan:
export declare function initializeApp(): FirebaseApp;
Hasil:
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, versi, varian)
Mendaftarkan nama dan versi library untuk tujuan logging platform.
Tanda Tangan:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| libraryKeyOrName | string | |
| versi | string | Versi library tersebut saat ini. |
| variant | string | Varian paket, misalnya, node, rn, dll. |
Hasil:
void
function(logCallback, ...)
onLog(logCallback, opsi)
Menetapkan pengendali log untuk semua Firebase SDK.
Tanda Tangan:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| logCallback | LogCallback | null (kosong) | Pengendali log kustom opsional yang mengeksekusi kode pengguna setiap kali Firebase SDK melakukan panggilan logging. |
| opsi | OpsiLog |
Hasil:
void
function(logLevel, ...)
setLogLevel(logLevel)
Menetapkan level log untuk semua Firebase SDK.
Semua jenis log di atas level log saat ini akan ditangkap (misalnya jika Anda menetapkan level log ke info, error akan dicatat, tetapi log debug dan verbose tidak akan dicatat).
Tanda Tangan:
export declare function setLogLevel(logLevel: LogLevelString): void;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| logLevel | LogLevelString |
Hasil:
void
function(nama, ...)
getApp(nama)
Mengambil instance FirebaseApp.
Jika dipanggil tanpa argumen, aplikasi default akan ditampilkan. Jika nama aplikasi diberikan, aplikasi yang sesuai dengan nama tersebut akan ditampilkan.
Pengecualian akan ditampilkan jika aplikasi yang diambil belum diinisialisasi.
Tanda Tangan:
export declare function getApp(name?: string): FirebaseApp;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| name | string | Nama opsional aplikasi yang akan ditampilkan. Jika nama tidak diberikan, defaultnya adalah "[DEFAULT]". |
Hasil:
Aplikasi yang sesuai dengan nama aplikasi yang diberikan. Jika nama aplikasi tidak diberikan, aplikasi default akan ditampilkan.
Contoh 1
// Return the default app
const app = getApp();
Contoh 2
// Return a named app
const otherApp = getApp("otherApp");
function(options, ...)
inisialisasiApp(opsi, nama)
Membuat dan menginisialisasi instance FirebaseApp.
Baca artikel Menambahkan Firebase ke aplikasi Anda dan Melakukan inisialisasi beberapa project untuk mendapatkan dokumentasi mendetail.
Tanda Tangan:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| opsi | FirebaseOptions | Opsi untuk mengonfigurasi layanan aplikasi. |
| name | string | Nama opsional aplikasi yang akan diinisialisasi. Jika nama tidak diberikan, defaultnya adalah "[DEFAULT]". |
Hasil:
Aplikasi yang diinisialisasi.
Contoh 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
});
Contoh 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
inisialisasiApp(opsi, konfigurasi)
Membuat dan menginisialisasi instance FirebaseApp.
Tanda Tangan:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| opsi | FirebaseOptions | Opsi untuk mengonfigurasi layanan aplikasi. |
| config | FirebaseAppSettings | Konfigurasi FirebaseApp |
Hasil:
inisialisasiServerApp(opsi, konfigurasi)
Membuat dan menginisialisasi instance FirebaseServerApp.
FirebaseServerApp mirip dengan FirebaseApp, tetapi hanya ditujukan untuk dieksekusi di lingkungan rendering sisi server. Inisialisasi akan gagal jika dipanggil dari lingkungan browser.
Baca artikel Menambahkan Firebase ke aplikasi Anda dan Melakukan inisialisasi beberapa project untuk mendapatkan dokumentasi mendetail.
Tanda Tangan:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| opsi | FirebaseOptions | AplikasiFirebase | Firebase.AppOptions untuk mengonfigurasi layanan aplikasi, atau instance FirebaseApp yang berisi AppOptions di dalamnya. |
| config | FirebaseServerAppSettings | Konfigurasi FirebaseServerApp. |
Hasil:
FirebaseServerApp yang diinisialisasi.
Contoh
// 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
Versi SDK saat ini.
Tanda Tangan:
SDK_VERSION: string