app-check package

SDK Web Pemeriksaan Aplikasi Firebase.

Firebase App Check tidak berfungsi di lingkungan Node.js menggunakan ReCaptchaV3Provider atau ReCaptchaEnterpriseProvider , tetapi dapat digunakan di Node.js jika Anda menggunakan CustomProvider dan menulis metode pengesahan Anda sendiri.

Fungsi

Kelas

Antarmuka

Ketik Alias

fungsi(aplikasi, ...)

inisialisasiAppCheck(aplikasi, opsi)

Aktifkan Pemeriksaan Aplikasi untuk aplikasi yang diberikan. Hanya dapat dipanggil sekali per aplikasi.

Tanda tangan:

export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;

Parameter

Pengembalian:

Pemeriksaan Aplikasi

fungsi(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Meminta token Firebase App Check. Metode ini sebaiknya digunakan hanya jika Anda perlu mengotorisasi permintaan ke backend non-Firebase.

Mengembalikan token penggunaan terbatas yang dimaksudkan untuk digunakan dengan backend endpoint non-Firebase yang dilindungi dengan Replay Protection . Metode ini tidak memengaruhi perilaku pembuatan token metode #getAppCheckToken().

Tanda tangan:

export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;

Parameter

Pengembalian:

Janji< AppCheckTokenResult >

Token penggunaan terbatas.

getToken(appCheckInstance, forceRefresh)

Dapatkan token App Check saat ini. Melampirkan permintaan dalam penerbangan terbaru jika ada. Mengembalikan null jika tidak ada token dan tidak ada permintaan token yang sedang dijalankan.

Tanda tangan:

export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;

Parameter

Pengembalian:

Janji< AppCheckTokenResult >

onTokenChanged(appCheckInstance, pengamat)

Mendaftarkan pendengar terhadap perubahan status token. Mungkin ada lebih dari satu pendengar yang terdaftar pada waktu yang sama untuk satu atau lebih contoh App Check. Listener memanggil kembali thread UI setiap kali token saat ini yang terkait dengan instance App Check ini berubah.

Tanda tangan:

export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;

Parameter

Pengembalian:

Berhenti berlangganan

Sebuah fungsi yang menghentikan langganan pendengar ini.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

Mendaftarkan pendengar terhadap perubahan status token. Mungkin ada lebih dari satu pendengar yang terdaftar pada waktu yang sama untuk satu atau lebih contoh App Check. Listener memanggil kembali thread UI setiap kali token saat ini yang terkait dengan instance App Check ini berubah.

Tanda tangan:

export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;

Parameter

Pengembalian:

Berhenti berlangganan

Sebuah fungsi yang menghentikan langganan pendengar ini.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

Atur apakah App Check akan secara otomatis menyegarkan token sesuai kebutuhan.

Tanda tangan:

export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;

Parameter

Pengembalian:

ruang kosong

AppCheckTokenListener

Listener yang dipanggil setiap kali token App Check berubah.

Tanda tangan:

export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;