firebase-admin.extensions package

Layanan Firebase Extensions.

Functions

Fungsi Deskripsi
getExtensions(aplikasi) Mendapatkan layanan Ekstensi untuk aplikasi default atau aplikasi tertentu.getExtensions() dapat dipanggil tanpa argumen untuk mengakses layanan Extensions aplikasi default, atau sebagai getExtensions(app) untuk mengakses layanan Extensions yang terkait dengan aplikasi tertentu.

Kelas

Class Deskripsi
Ekstensi Antarmuka layanan Extensions Firebase.
Runtime Runtime menyediakan metode untuk mengubah data runtime instance ekstensi.

Jenis Alias

Jenis Alias Deskripsi
SettableProcessingState SettableProcessingState menampilkan semua status pemrosesan yang dapat ditetapkan pada data runtime instance Ekstensi.

getExtensions(aplikasi)

Mendapatkan layanan Ekstensi untuk aplikasi default atau aplikasi tertentu.

getExtensions() dapat dipanggil tanpa argumen untuk mengakses layanan Extensions aplikasi default atau sebagai getExtensions(app) untuk mengakses layanan Extensions yang terkait dengan aplikasi tertentu.

Tanda Tangan:

export declare function getExtensions(app?: App): Extensions;

Parameter

Parameter Jenis Deskripsi
aplikasi Aplikasi Aplikasi opsional yang akan menampilkan layanan Extensions. Jika tidak diberikan, layanan Extensions default akan ditampilkan.

Hasil:

Ekstensi

Layanan Extensions default jika tidak ada aplikasi yang disediakan, atau layanan Extensions yang dikaitkan dengan aplikasi yang disediakan.

Contoh 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Contoh 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

SettableProcessingState

SettableProcessingState menampilkan semua status pemrosesan yang dapat ditetapkan pada data runtime instance Ekstensi.

Anda dapat menetapkan status berikut:

  • NONE: Belum ada pekerjaan peristiwa siklus proses yang relevan. Tetapkan ini untuk menghapus status lama.

  • PROCESSING_COMPLETE: Pekerjaan peristiwa siklus proses selesai tanpa error.

  • PROCESSING_WARNING: Pekerjaan peristiwa siklus proses berhasil sebagian, atau sesuatu terjadi yang harus diperingatkan oleh pengguna.

  • PROCESSING_FAILED: Pekerjaan peristiwa siklus proses gagal sepenuhnya, tetapi instance akan tetap berfungsi dengan benar ke depannya.

Jika instance ekstensi dalam status rusak karena error, panggil Runtime.setFatalError().

Status "pemrosesan" ditetapkan secara otomatis saat pengendali peristiwa siklus proses dimulai; Anda tidak dapat menetapkannya secara eksplisit. Untuk melaporkan status berkelanjutan dari fungsi ekstensi, gunakan console.log atau SDK logger Cloud Functions.

Tanda Tangan:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';