Firebase App Check Web SDK.
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.
Functions
| Fungsi | Deskripsi |
|---|---|
| fungsi(aplikasi, ...) | |
| InitializeAppCheck(aplikasi, opsi) | Aktifkan App Check untuk aplikasi tertentu. Hanya dapat dipanggil sekali per aplikasi. |
| function(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Meminta token Firebase App Check. Metode ini sebaiknya hanya digunakan jika Anda perlu mengizinkan permintaan ke backend non-Firebase.Menampilkan token penggunaan terbatas yang dimaksudkan untuk digunakan dengan endpoint backend non-Firebase yang dilindungi dengan Replay Protection. Metode ini tidak memengaruhi perilaku pembuatan token untuk metode #getAppCheckToken(). |
| getToken(appCheckInstance, forceRefresh) | Dapatkan token App Check terbaru. Jika forceRefresh salah, fungsi ini terlebih dahulu memeriksa token yang valid di memori, lalu persistensi lokal (Ah). Jika tidak ditemukan, atau jika forceRefresh bernilai benar, sistem akan membuat permintaan ke endpoint App Check untuk mendapatkan token baru. Permintaan tersebut dilampirkan ke permintaan terbaru yang sedang berlangsung, jika ada. |
| onTokenDiubah(appCheckInstance, observer) | Mendaftarkan pemroses terhadap perubahan status token. Mungkin ada lebih dari satu pemroses yang terdaftar secara bersamaan untuk satu atau beberapa instance App Check. Pemroses akan memanggil kembali UI thread setiap kali token saat ini yang terkait dengan instance App Check ini berubah. |
| onTokenDiubah(appCheckInstance, onNext, onError, onCompletion) | Mendaftarkan pemroses terhadap perubahan status token. Mungkin ada lebih dari satu pemroses yang terdaftar secara bersamaan untuk satu atau beberapa instance App Check. Pemroses akan memanggil kembali UI thread setiap kali token saat ini yang terkait dengan instance App Check ini berubah. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Tetapkan apakah App Check akan otomatis memperbarui token sesuai kebutuhan. |
Kelas
| Class | Deskripsi |
|---|---|
| CustomProvider | Class penyedia kustom. |
| ReCaptchaEnterpriseProvider | Penyedia App Check yang dapat memperoleh token reCAPTCHA Enterprise dan menukarkannya dengan token App Check. |
| ReCaptchaV3Provider | Penyedia App Check yang dapat memperoleh token reCAPTCHA V3 dan menukarkannya dengan token App Check. |
Antarmuka
| Antarmuka | Deskripsi |
|---|---|
| AppCheck | Antarmuka layanan Firebase App Check. |
| AppCheckOptions | Opsi untuk inisialisasi App Check. |
| AppCheckToken | Token yang ditampilkan dari penyedia App Check. |
| AppCheckTokenResult | Hasil yang ditampilkan oleh getToken(). |
| CustomProviderOptions | Opsi saat membuat CustomProvider. |
Ketik Alias
| Ketik Alias | Deskripsi |
|---|---|
| AppCheckTokenListener | Pemroses yang dipanggil setiap kali token App Check berubah. |
function(aplikasi, ...)
inisialisasiAppCheck(aplikasi, opsi)
Aktifkan App Check untuk aplikasi tertentu. Hanya dapat dipanggil sekali per aplikasi.
Tanda Tangan:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| aplikasi | FirebaseApp | tidak ditentukan | FirebaseApp guna mengaktifkan App Check untuk |
| opsi | AppCheckOptions | Opsi inisialisasi App Check |
Hasil:
function(appCheckInstance, ...)
getTerbatasUseToken(appCheckInstance)
Meminta token Firebase App Check. Metode ini sebaiknya hanya digunakan jika Anda perlu mengizinkan permintaan ke backend non-Firebase.
Menampilkan token penggunaan terbatas yang dimaksudkan untuk digunakan dengan endpoint backend non-Firebase yang dilindungi dengan Perlindungan Replay. Metode ini tidak memengaruhi perilaku pembuatan token untuk metode #getAppCheckToken().
Tanda Tangan:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| appCheckInstance | AppCheck | Instance layanan App Check. |
Hasil:
Promise<AppCheckTokenResult>
Token penggunaan terbatas.
getToken(appCheckInstance, forceRefresh)
Dapatkan token App Check terbaru. Jika forceRefresh salah, fungsi ini terlebih dahulu memeriksa token yang valid di memori, lalu persistensi lokal (Ah). Jika tidak ditemukan, atau jika forceRefresh bernilai benar, sistem akan membuat permintaan ke endpoint App Check untuk mendapatkan token baru. Permintaan tersebut dilampirkan ke permintaan terbaru yang sedang berlangsung, jika ada.
Tanda Tangan:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| appCheckInstance | AppCheck | Instance layanan App Check. |
| muat ulang paksa | boolean | Jika true (benar), akan selalu mencoba mengambil token baru. Jika salah, token yang di-cache akan digunakan jika ditemukan di penyimpanan. |
Hasil:
Promise<AppCheckTokenResult>
onTokenDiubah(appCheckInstance, observer)
Mendaftarkan pemroses terhadap perubahan status token. Mungkin ada lebih dari satu pemroses yang terdaftar secara bersamaan untuk satu atau beberapa instance App Check. Pemroses akan memanggil kembali UI thread 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 | Deskripsi |
|---|---|---|
| appCheckInstance | AppCheck | Instance layanan App Check. |
| {i>Observer<i} | PartialObserver<AppCheckTokenResult> | Objek dengan properti next, error, dan complete. next dipanggil dengan AppCheckTokenResult setiap kali token berubah. error bersifat opsional dan dipanggil jika error ditampilkan oleh pemroses (fungsi next). complete tidak digunakan, karena aliran data token tidak berakhir. |
Hasil:
Fungsi yang menghentikan langganan pemroses ini.
onTokenDiubah(appCheckInstance, onNext, onError, onCompletion)
Mendaftarkan pemroses terhadap perubahan status token. Mungkin ada lebih dari satu pemroses yang terdaftar secara bersamaan untuk satu atau beberapa instance App Check. Pemroses akan memanggil kembali UI thread 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 | Deskripsi |
|---|---|---|
| appCheckInstance | AppCheck | Instance layanan App Check. |
| padaBerikutnya | (tokenResult: AppCheckTokenResult) => kosong | Saat token berubah, fungsi ini dipanggil dengan AppCheckTokenResult. |
| onError | (error: Error) => kosong | Opsional. Dipanggil jika ada error yang ditampilkan oleh pemroses (fungsi onNext). |
| saat Penyelesaian | () => kosong | Saat ini tidak digunakan, karena streaming token tidak berakhir. |
Hasil:
Fungsi yang menghentikan langganan pemroses ini.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Tetapkan apakah App Check akan otomatis memperbarui token sesuai kebutuhan.
Tanda Tangan:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| appCheckInstance | AppCheck | Instance layanan App Check. |
| isTokenAutoRefreshEnabled | boolean | Jika true (benar), SDK akan otomatis memperbarui token App Check sesuai kebutuhan. Tindakan ini akan mengganti nilai apa pun yang ditetapkan selama initializeAppCheck(). |
Hasil:
void
AppCheckTokenListener
Pemroses yang dipanggil setiap kali token App Check berubah.
Tanda Tangan:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;