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
Fungsi | Keterangan |
---|---|
fungsi(aplikasi, ...) | |
inisialisasiAppCheck(aplikasi, opsi) | Aktifkan Pemeriksaan Aplikasi untuk aplikasi yang diberikan. Hanya dapat dipanggil sekali per 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(). |
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. |
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. |
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. |
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Atur apakah App Check akan secara otomatis menyegarkan token sesuai kebutuhan. |
Kelas
Kelas | Keterangan |
---|---|
Penyedia Khusus | Kelas penyedia khusus. |
Penyedia Perusahaan ReCaptcha | Penyedia App Check yang dapat memperoleh token reCAPTCHA Enterprise dan menukarnya dengan token App Check. |
Penyedia ReCaptchaV3 | Penyedia App Check yang dapat memperoleh token reCAPTCHA V3 dan menukarnya dengan token App Check. |
Antarmuka
Antarmuka | Keterangan |
---|---|
Pemeriksaan Aplikasi | Antarmuka layanan Firebase App Check. |
Opsi Pemeriksaan Aplikasi | Opsi untuk inisialisasi App Check. |
AppCheckToken | Token dikembalikan dari penyedia App Check. |
Hasil AppCheckToken | Hasil dikembalikan oleh getToken() . |
Opsi Penyedia Khusus | Opsi saat membuat CustomProvider . |
Ketik Alias
Ketik Alias | Keterangan |
---|---|
AppCheckTokenListener | Listener yang dipanggil setiap kali token App Check berubah. |
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
Parameter | Jenis | Keterangan |
---|---|---|
aplikasi | Aplikasi Firebase | belum diartikan | FirebaseApp untuk mengaktifkan App Check |
pilihan | Opsi Pemeriksaan Aplikasi | Opsi inisialisasi Pemeriksaan Aplikasi |
Pengembalian:
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
Parameter | Jenis | Keterangan |
---|---|---|
appCheckInstance | Pemeriksaan Aplikasi | Contoh layanan App Check. |
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
Parameter | Jenis | Keterangan |
---|---|---|
appCheckInstance | Pemeriksaan Aplikasi | Contoh layanan App Check. |
forceRefresh | boolean | Jika benar, akan selalu mencoba mengambil token baru. Jika salah, akan menggunakan token cache jika ditemukan di penyimpanan. |
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
Parameter | Jenis | Keterangan |
---|---|---|
appCheckInstance | Pemeriksaan Aplikasi | Contoh layanan App Check. |
pengamat | Pengamat Parsial < AppCheckTokenResult > | Objek dengan properti next , error , dan complete . next dipanggil dengan AppCheckTokenResult setiap kali token berubah. error bersifat opsional dan dipanggil jika kesalahan terjadi oleh pendengar (fungsi next ). complete tidak digunakan, karena aliran token tidak ada habisnya. |
Pengembalian:
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
Parameter | Jenis | Keterangan |
---|---|---|
appCheckInstance | Pemeriksaan Aplikasi | Contoh layanan App Check. |
padaBerikutnya | (tokenResult: AppCheckTokenResult ) => batal | Saat token berubah, fungsi ini dipanggil dengan AppCheckTokenResult . |
diError | (kesalahan: Kesalahan) => batal | Opsional. Dipanggil jika ada kesalahan yang dilontarkan oleh pendengar (fungsi onNext ). |
dalam penyelesaian | () => batal | Saat ini tidak digunakan, karena aliran token tidak ada habisnya. |
Pengembalian:
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
Parameter | Jenis | Keterangan |
---|---|---|
appCheckInstance | Pemeriksaan Aplikasi | Contoh layanan App Check. |
isTokenAutoRefreshDiaktifkan | boolean | Jika benar, SDK secara otomatis menyegarkan token App Check sesuai kebutuhan. Ini mengesampingkan nilai apa pun yang ditetapkan selama initializeAppCheck() . |
Pengembalian:
ruang kosong
AppCheckTokenListener
Listener yang dipanggil setiap kali token App Check berubah.
Tanda tangan:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;