Inisialisasi Aplikasi Firebase dan SDK.
Functions
| Fungsi | Deskripsi |
|---|---|
| applicationDefault(httpAgent) | Menampilkan kredensial yang dibuat dari Kredensial Default Aplikasi Google yang memberikan akses admin ke layanan Firebase. Kredensial ini dapat digunakan dalam panggilan ke InitializeApp().Kredensial Default Aplikasi Google tersedia di infrastruktur Google apa pun, seperti Google App Engine dan Google Compute Engine.Lihat Menginisialisasi SDK untuk mengetahui detail selengkapnya. |
| cert(serviceAccountPathOrObject, httpAgent) | Menampilkan kredensial yang dibuat dari akun layanan yang disediakan yang memberikan akses admin ke layanan Firebase. Kredensial ini dapat digunakan dalam panggilan ke InitializeApp().Lihat Menginisialisasi SDK untuk mengetahui detail selengkapnya. |
| deleteApp(aplikasi) | Merender App karena tidak dapat digunakan dan membebaskan resource semua layanan terkait (meskipun itu *tidak* membersihkan resource backend). Saat menjalankan SDK secara lokal, metode ini harus dipanggil untuk memastikan penghentian proses dengan lancar. |
| getApp(namaaplikasi) | |
| getApps() | |
| inisialisasiApp(options, appName) | |
| refreshToken(refreshTokenPathOrObject, httpAgent) | Menampilkan kredensial yang dibuat dari token refresh yang diberikan, yang memberikan akses admin ke layanan Firebase. Kredensial ini dapat digunakan dalam panggilan ke InitializeApp().Lihat Menginisialisasi SDK untuk mengetahui detail selengkapnya. |
Kelas
| Class | Deskripsi |
|---|---|
| AppErrorCode | Kode error klien aplikasi dan pesan defaultnya. |
| FirebaseAppError | Struktur kode error Aplikasi Firebase. Tindakan ini akan memperluas PrefixedFirebaseError. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| Aplikasi | Aplikasi Firebase menyimpan informasi inisialisasi untuk sekumpulan layanan. |
| AppOptions | Opsi yang tersedia untuk diteruskan ke InitializeApp(). |
| Kredensial | Antarmuka yang menyediakan token akses Google OAuth2 yang digunakan untuk mengautentikasi dengan layanan Firebase.Pada umumnya, Anda tidak perlu menerapkannya sendiri dan dapat menggunakan implementasi default yang disediakan oleh modul firebase-admin/app. |
| FirebaseArrayIndexError | Jenis komposit yang mencakup objek FirebaseError dan indeks yang dapat digunakan untuk mendapatkan item yang mengalami error. |
| FirebaseError | FirebaseError adalah subclass dari objek Error JavaScript standar. Selain string pesan dan pelacakan tumpukan, kode ini juga berisi kode string. |
| GoogleOAuthAccessToken | Antarmuka untuk token akses Google OAuth 2.0. |
| AkunLayanan |
Variabel
| Variabel | Deskripsi |
|---|---|
| Versi_SDK |
applicationDefault(httpAgent)
Menampilkan kredensial yang dibuat dari Kredensial Default Aplikasi Google yang memberikan akses admin ke layanan Firebase. Kredensial ini dapat digunakan dalam panggilan ke InitializeApp().
Kredensial Default Aplikasi Google tersedia di infrastruktur Google apa pun, seperti Google App Engine dan Google Compute Engine.
Lihat Melakukan inisialisasi SDK untuk detail selengkapnya.
Tanda Tangan:
export declare function applicationDefault(httpAgent?: Agent): Credential;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| httpAgent | Agen | Agen HTTP opsional untuk digunakan saat mengambil token akses dari server token Google. |
Hasil:
Kredensial yang diautentikasi melalui Kredensial Default Aplikasi Google yang dapat digunakan untuk menginisialisasi aplikasi.
Contoh
initializeApp({
credential: applicationDefault(),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
cert(serviceAccountPathOrObject, httpAgent)
Menampilkan kredensial yang dibuat dari akun layanan yang disediakan yang memberikan akses admin ke layanan Firebase. Kredensial ini dapat digunakan dalam panggilan ke InitializeApp().
Lihat Melakukan inisialisasi SDK untuk detail selengkapnya.
Tanda Tangan:
export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| serviceAccountPathOrObject | rangkaian | AkunLayanan | Jalur ke file JSON kunci akun layanan atau objek yang mewakili kunci akun layanan. |
| httpAgent | Agen | Agen HTTP opsional untuk digunakan saat mengambil token akses dari server token Google. |
Hasil:
Kredensial yang diautentikasi melalui akun layanan yang disediakan, yang dapat digunakan untuk menginisialisasi aplikasi.
Contoh 1
// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
credential: cert(serviceAccount),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
Contoh 2
// Providing a service account object inline
initializeApp({
credential: cert({
projectId: "<PROJECT_ID>",
clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
}),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
deleteApp(aplikasi)
Merender App karena tidak dapat digunakan dan membebaskan resource semua layanan terkait (meskipun itu *tidak* membersihkan resource backend). Saat menjalankan SDK secara lokal, metode ini harus dipanggil untuk memastikan penghentian proses dengan lancar.
Tanda Tangan:
export declare function deleteApp(app: App): Promise<void>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| aplikasi | Aplikasi |
Hasil:
Janji<void>
Contoh
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
getApp(namaaplikasi)
Tanda Tangan:
export declare function getApp(appName?: string): App;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| Namaaplikasi | string |
Hasil:
getApps()
Tanda Tangan:
export declare function getApps(): App[];
Hasil:
Aplikasi[]
inisialisasiApp(options, appName)
Tanda Tangan:
export declare function initializeApp(options?: AppOptions, appName?: string): App;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| opsi | AppOptions | |
| Namaaplikasi | string |
Hasil:
refreshToken(refreshTokenPathOrObject, httpAgent)
Menampilkan kredensial yang dibuat dari token refresh yang diberikan, yang memberikan akses admin ke layanan Firebase. Kredensial ini dapat digunakan dalam panggilan ke InitializeApp().
Lihat Melakukan inisialisasi SDK untuk detail selengkapnya.
Tanda Tangan:
export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| refreshTokenPathOrObject | rangkaian | objek | Jalur ke file JSON token refresh Google OAuth2 atau objek yang mewakili token refresh Google OAuth2. |
| httpAgent | Agen | Agen HTTP opsional untuk digunakan saat mengambil token akses dari server token Google. |
Hasil:
Kredensial yang diautentikasi melalui akun layanan yang disediakan, yang dapat digunakan untuk menginisialisasi aplikasi.
Contoh
// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
credential: refreshToken(refreshToken),
databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});
SDK_VERSION
Tanda Tangan:
SDK_VERSION: string