Firebase Uygulama Kontrolü Web SDK'sı.
Firebase Uygulama Kontrolü, ReCaptchaV3Provider veya ReCaptchaEnterpriseProvider kullanılarak Node.js ortamında çalışmaz, ancak CustomProvider kullanıyorsanız ve kendi onay yönteminizi yazıyorsanız Node.js'de kullanılabilir.
İşlevler
| İşlev | Açıklama |
|---|---|
| fonksiyon(uygulama, ...) | |
| initializeAppCheck(uygulama, seçenekler) | Belirtilen uygulama için Uygulama Kontrolü'nü etkinleştirin. Uygulama başına yalnızca bir kez çağrılabilir. |
| fonksiyon(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Firebase Uygulama Kontrolü jetonu ister. Bu yöntem yalnızca Firebase olmayan bir arka uca istekleri yetkilendirmeniz gerekiyorsa kullanılmalıdır. Tekrar Oynatma Koruması ile korunan, Firebase olmayan arka uç uç noktalarınızla kullanılması amaçlanan sınırlı kullanım amaçlı jetonları döndürür. Bu yöntem, #getAppCheckToken() yönteminin jeton oluşturma davranışını etkilemez. |
| getToken(appCheckInstance, forceRefresh) | Geçerli Uygulama Kontrolü jetonunu alın. forceRefresh değeri yanlışsa bu işlev önce bellekte geçerli bir jeton olup olmadığını, ardından yerel kalıcılığı (IndexedDB) kontrol eder. Bulunamazsa veya forceRefresh doğru ise yeni bir jeton için Uygulama Kontrolü uç noktasına istek gönderir. Bu istek, varsa en son yayındaki isteğe eklenir. |
| onTokenChanged(appCheckInstance, gözlemci) | Bir işleyiciyi jeton durumundaki değişikliklere kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kaydedilmiş birden fazla dinleyici olabilir. Dinleyiciler, bu Uygulama Kontrolü örneğiyle ilişkilendirilmiş mevcut jeton değiştiğinde kullanıcı arayüzü iş parçacığını geri çağırır. |
| onTokenChanged(appCheckInstance, onNext, onError, onComplete) | Bir işleyiciyi jeton durumundaki değişikliklere kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kaydedilmiş birden fazla dinleyici olabilir. Dinleyiciler, bu Uygulama Kontrolü örneğiyle ilişkilendirilmiş mevcut jeton değiştiğinde kullanıcı arayüzü iş parçacığını geri çağırır. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Uygulama Kontrolü'nün jetonları gerektiğinde otomatik olarak yenileyip yenilemeyeceğini ayarlayın. |
Sınıflar
| Sınıf | Açıklama |
|---|---|
| Özel Sağlayıcı | Özel sağlayıcı sınıfı. |
| ReCaptchaEnterpriseProvider | reCAPTCHA Enterprise jetonu alıp bu jetonu Uygulama Kontrolü jetonuyla değiştirebilen Uygulama Kontrolü sağlayıcısıdır. |
| ReCaptchaV3Provider | reCAPTCHA V3 jetonu alıp bu jetonu Uygulama Kontrolü jetonuyla değiştirebilen Uygulama Kontrolü sağlayıcısıdır. |
Arayüzler
| Arayüz | Açıklama |
|---|---|
| Uygulama Kontrolü | Firebase Uygulama Kontrolü hizmeti arayüzü. |
| AppCheckOptions | Uygulama Kontrolü başlatma seçenekleri |
| AppCheckToken | Uygulama Kontrolü sağlayıcısından döndürülen jeton. |
| AppCheckTokenResult | getToken() tarafından döndürülen sonuç. |
| CustomProviderOptions | CustomProvider oluştururken kullanabileceğiniz seçenekler. |
Tür Takma Adları
| Takma Ad yazın | Açıklama |
|---|---|
| AppCheckTokenListener | Uygulama Kontrolü jetonu her değiştiğinde çağrılan bir işleyici. |
function(uygulama; ...)
startizeAppCheck(uygulama; seçenekler)
Belirtilen uygulama için Uygulama Kontrolü'nü etkinleştirin. Uygulama başına yalnızca bir kez çağrılabilir.
İmza:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uygulama | FirebaseApp | tanımsız | FirebaseApp'te bulunan Uygulama Kontrolü'nü |
| seçenekler | AppCheckOptions | Uygulama Kontrolü başlatma seçenekleri |
Şunu döndürür:
function(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Firebase Uygulama Kontrolü jetonu ister. Bu yöntem yalnızca, Firebase dışı bir arka uca yapılan istekleri yetkilendirmeniz gerekiyorsa kullanılmalıdır.
Tekrar Koruması ile korunan, Firebase dışı arka uç uç noktalarınızla kullanılması amaçlanan sınırlı kullanımlı jetonlar döndürür. Bu yöntem, #getAppCheckToken() yönteminin jeton oluşturma davranışını etkilemez.
İmza:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmet örneği. |
Şunu döndürür:
Promise<AppCheckTokenResult>
Sınırlı kullanım jetonu.
getToken(appCheckInstance, forceRefresh)
Geçerli Uygulama Kontrolü jetonunu alın. forceRefresh değeri yanlışsa bu işlev önce bellekte geçerli bir jeton olup olmadığını, ardından yerel kalıcılığı (IndexedDB) kontrol eder. Bulunamazsa veya forceRefresh doğru ise yeni bir jeton için Uygulama Kontrolü uç noktasına istek gönderir. Bu istek, varsa en son yayındaki isteğe eklenir.
İmza:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmet örneği. |
| kuvvet-Yenile | boolean | True (doğru) ise her zaman yeni bir jeton getirmeye çalışır. Yanlış değerine ayarlanırsa depolama alanında bulunursa önbelleğe alınan jeton kullanılır. |
Şunu döndürür:
Promise<AppCheckTokenResult>
onTokenChanged(appCheckInstance, gözlemci)
Bir işleyiciyi jeton durumundaki değişikliklere kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kaydedilmiş birden fazla dinleyici olabilir. Dinleyiciler, bu Uygulama Kontrolü örneğiyle ilişkilendirilmiş mevcut jeton değiştiğinde kullanıcı arayüzü iş parçacığını geri çağırır.
İmza:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmet örneği. |
| gözlemci | KısmiObserver<AppCheckTokenResult> | next, error ve complete özelliklerine sahip bir nesne. Jeton her değiştiğinde next, bir AppCheckTokenResult ile çağrılır. error isteğe bağlıdır ve işleyici (next işlevi) tarafından hata bildirilirse çağrılır. Jeton akışı devam ettiği için complete kullanılmıyor. |
Şunu döndürür:
Bu işleyicinin aboneliğini iptal eden bir işlev.
onTokenChanged(appCheckInstance, onNext, onError, onComplete)
Bir işleyiciyi jeton durumundaki değişikliklere kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kaydedilmiş birden fazla dinleyici olabilir. Dinleyiciler, bu Uygulama Kontrolü örneğiyle ilişkilendirilmiş mevcut jeton değiştiğinde kullanıcı arayüzü iş parçacığını geri çağırır.
İmza:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmet örneği. |
| sonraki | (tokenResult: AppCheckTokenResult) => geçersiz | Jeton değiştiğinde bu işlev bir AppCheckTokenResult ile çağrılır. |
| onError | (hata: Hata) => geçersiz | İsteğe bağlı. İşleyici tarafından bir hata bildirilirse (onNext işlevi) çağrılır. |
| onTamamlanma | () => geçersiz | Jeton akışı devam ettiği için şu anda kullanılmamaktadır. |
Şunu döndürür:
Bu işleyicinin aboneliğini iptal eden bir işlev.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Uygulama Kontrolü'nün jetonları gerektiğinde otomatik olarak yenileyip yenilemeyeceğini ayarlayın.
İmza:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmet örneği. |
| isTokenAutoRefreshEnabled | boolean | Doğru değerine ayarlanırsa SDK, Uygulama Kontrolü jetonlarını gerektiğinde otomatik olarak yeniler. Bu, initializeAppCheck() sırasında ayarlanan tüm değerleri geçersiz kılar. |
Şunu döndürür:
geçersiz
AppCheckTokenListener
Uygulama Kontrolü jetonu her değiştiğinde çağrılan bir işleyici.
İmza:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;