firebase-admin.app package

Inisialisasi Aplikasi Firebase dan SDK.

Functions

Kelas

Antarmuka

Variabel

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

Hasil:

Kredensial

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

Hasil:

Kredensial

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

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

Hasil:

Aplikasi

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

Hasil:

Aplikasi

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

Hasil:

Kredensial

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