Firebase Uygulaması Kontrol Web SDK'sı.
Firebase Uygulama Kontrolü, ReCaptchaV3Provider
veya ReCaptchaEnterpriseProvider
kullanan Node.js ortamında çalışmıyor , ancak CustomProvider
kullanırsanız ve kendi kanıtlama yönteminizi yazarsanız Node.js'de kullanılabilir.
Fonksiyonlar
İşlev | Tanım |
---|---|
işlev(uygulama, ...) | |
AppCheck'i başlat(uygulama, seçenekler) | Verilen uygulama için Uygulama Kontrolünü etkinleştirin. Uygulama başına yalnızca bir kez çağrılabilir. |
işlev(appCheckInstance, ...) | |
getLimitedUseToken(appCheckInstance) | Firebase Uygulama Kontrolü jetonu ister. Bu yöntem yalnızca istekleri Firebase olmayan bir arka uca 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ı belirteçleri döndürür. Bu yöntem #getAppCheckToken() yönteminin belirteç oluşturma davranışını etkilemez. |
getToken(appCheckInstance,forceRefresh) | Mevcut Uygulama Kontrolü jetonunu alın. Varsa, en son uçuş içi talebe eklenir. Hiçbir belirteç mevcut değilse ve herhangi bir belirteç isteği yayında değilse null değerini döndürür. |
onTokenChanged(appCheckInstance, gözlemci) | Belirteç durumundaki değişikliklere bir dinleyici kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kayıtlı birden fazla dinleyici olabilir. Bu Uygulama Denetimi örneğiyle ilişkili geçerli belirteç değiştiğinde dinleyiciler UI iş parçacığını geri arar. |
onTokenChanged(appCheckInstance, onNext, onError, onCompletion) | Belirteç durumundaki değişikliklere bir dinleyici kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kayıtlı birden fazla dinleyici olabilir. Bu Uygulama Denetimi örneğiyle ilişkili geçerli belirteç değiştiğinde dinleyiciler UI iş parçacığını geri arar. |
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Uygulama Kontrolü'nün gerektiğinde belirteçleri otomatik olarak yenileyip yenilemeyeceğini ayarlayın. |
Sınıflar
Sınıf | Tanım |
---|---|
Özel Sağlayıcı | Özel sağlayıcı sınıfı. |
ReCaptchaEnterpriseProvider | Bir reCAPTCHA Enterprise jetonu alabilen ve bunu bir Uygulama Kontrolü jetonuyla değiştirebilen Uygulama Kontrolü sağlayıcısı. |
ReCaptchaV3 Sağlayıcısı | Bir reCAPTCHA V3 jetonu alabilen ve bunu bir Uygulama Kontrolü jetonuyla değiştirebilen Uygulama Kontrolü sağlayıcısı. |
Arayüzler
Arayüz | Tanım |
---|---|
Uygulama Kontrolü | Firebase Uygulama Kontrolü hizmet arayüzü. |
Uygulama Kontrolü Seçenekleri | Uygulama Kontrolü başlatma seçenekleri. |
AppCheckToken | Belirteç bir Uygulama Kontrolü sağlayıcısından geri döndü. |
AppCheckTokenResult | Sonuç getToken() tarafından döndürüldü. |
Özel Sağlayıcı Seçenekleri | CustomProvider oluştururken seçenekler . |
Takma Adları Yazın
Takma Ad yazın | Tanım |
---|---|
AppCheckTokenListener | Uygulama Kontrolü jetonu değiştiğinde çağrılan bir dinleyici. |
işlev(uygulama, ...)
AppCheck'i başlat(uygulama, seçenekler)
Verilen 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 | Tip | Tanım |
---|---|---|
uygulama | Firebase Uygulaması | Tanımsız | Uygulama Kontrolünü etkinleştirmek için FirebaseApp'i kullanın |
seçenekler | Uygulama Kontrolü Seçenekleri | Uygulama Kontrolü başlatma seçenekleri |
İadeler:
işlev(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Firebase Uygulama Kontrolü jetonu ister. Bu yöntem yalnızca istekleri Firebase olmayan bir arka uca 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ı belirteçleri döndürür. Bu yöntem #getAppCheckToken() yönteminin belirteç oluşturma davranışını etkilemez.
İmza:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmeti örneği. |
İadeler:
Söz< AppCheckTokenResult >
Sınırlı kullanım jetonu.
getToken(appCheckInstance,forceRefresh)
Mevcut Uygulama Kontrolü jetonunu alın. Varsa, en son uçuş içi talebe eklenir. Hiçbir belirteç mevcut değilse ve herhangi bir belirteç isteği yayında değilse null değerini döndürür.
İmza:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmeti örneği. |
kuvvetYenileme | boolean | Doğruysa her zaman yeni bir token almaya çalışacaktır. Yanlışsa, depolamada bulunursa önbelleğe alınmış bir belirteci kullanır. |
İadeler:
Söz< AppCheckTokenResult >
onTokenChanged(appCheckInstance, gözlemci)
Belirteç durumundaki değişikliklere bir dinleyici kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kayıtlı birden fazla dinleyici olabilir. Bu Uygulama Denetimi örneğiyle ilişkili geçerli belirteç değiştiğinde dinleyiciler UI iş parçacığını geri arar.
İmza:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmeti örneği. |
gözlemci | Kısmi Gözlemci < AppCheckTokenResult > | next , error complete özelliklerine sahip bir nesne. next belirteç her değiştiğinde AppCheckTokenResult ile çağrılır. error isteğe bağlıdır ve dinleyici tarafından bir hata atılırsa ( next işlev) çağrılır. Belirteç akışı bitmediği için complete kullanılmaz. |
İadeler:
Bu dinleyicinin aboneliğini iptal eden bir işlev.
onTokenChanged(appCheckInstance, onNext, onError, onCompletion)
Belirteç durumundaki değişikliklere bir dinleyici kaydeder. Bir veya daha fazla Uygulama Kontrolü örneği için aynı anda kayıtlı birden fazla dinleyici olabilir. Bu Uygulama Denetimi örneğiyle ilişkili geçerli belirteç değiştiğinde dinleyiciler UI iş parçacığını geri arar.
İmza:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmeti örneği. |
sonraki | (tokenResult: AppCheckTokenResult ) => geçersiz | Belirteç değiştiğinde bu işlev bir AppCheckTokenResult ile çağrılır. . |
onError | (hata: Hata) => geçersiz | İsteğe bağlı. Dinleyici tarafından atılan bir hata varsa çağrılır ( onNext işlevi). |
tamamlandığında | () => geçersiz | Belirteç akışı bitmediği için şu anda kullanılmıyor. |
İadeler:
Bu dinleyicinin aboneliğini iptal eden bir işlev.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Uygulama Kontrolü'nün gerektiğinde belirteçleri otomatik olarak yenileyip yenilemeyeceğini ayarlayın.
İmza:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parametreler
Parametre | Tip | Tanım |
---|---|---|
appCheckInstance | Uygulama Kontrolü | Uygulama Kontrolü hizmeti örneği. |
isTokenAutoRefreshEnabled | boolean | Doğruysa SDK, Uygulama Kontrolü belirteçlerini gerektiği gibi otomatik olarak yeniler. Bu, initializeAppCheck() sırasında ayarlanan herhangi bir değeri geçersiz kılar. |
İadeler:
geçersiz
AppCheckTokenListener
Uygulama Kontrolü jetonu değiştiğinde çağrılan bir dinleyici.
İmza:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;