app-check package

Firebase App Check वेब SDK टूल.

'Firebase App Check', ReCaptchaV3Provider या ReCaptchaEnterpriseProvider का इस्तेमाल करके Node.js वाले एनवायरमेंट में काम नहीं करता है. हालांकि, CustomProvider का इस्तेमाल करने और प्रमाणित करने का अपना तरीका लिखने पर, Node.js में इसका इस्तेमाल किया जा सकता है.

फ़ंक्शन

फ़ंक्शन	ब्यौरा
फ़ंक्शन(ऐप्लिकेशन, ...)
StartizeAppCheck(ऐप्लिकेशन, विकल्प)	दिए गए ऐप्लिकेशन के लिए, App Check की सुविधा चालू करें. हर ऐप्लिकेशन के लिए सिर्फ़ एक बार कॉल किया जा सकता है.
फ़ंक्शन(appCheckInstance, ...)
getlimitedUseToken(appCheckInstance)	Firebase ऐप्लिकेशन जांच टोकन का अनुरोध करता है. इस तरीके का इस्तेमाल सिर्फ़ तब किया जाना चाहिए, जब आपको किसी गैर-Firebase बैकएंड को अनुरोध भेजने की अनुमति देनी हो.यह सीमित इस्तेमाल के लिए इस्तेमाल होने वाले टोकन दिखाता है. ये टोकन, आपके गैर-Firebase बैकएंड एंडपॉइंट के साथ इस्तेमाल करने के लिए होते हैं. साथ ही, फिर से चलाने की सुरक्षा की मदद से सुरक्षित किया जाता है. #getAppCheckToken() तरीके के टोकन जनरेशन के व्यवहार पर इस तरीके का कोई असर नहीं पड़ता है.
getToken(appCheckInstance, forceRefresh)	मौजूदा ऐप्लिकेशन चेक टोकन पाएं. अगर forceRefresh गलत है, तो यह फ़ंक्शन पहले मेमोरी में किसी मान्य टोकन की जांच करता है. इसके बाद, लोकल परसिस्टेंस (IndexedDB) का पता चलता है. अगर उपयोगकर्ता की जानकारी नहीं मिलती है या forceRefresh सही है, तो यह ऐप्लिकेशन की जांच वाले एंडपॉइंट पर नए टोकन का अनुरोध करता है. अगर कोई हाल ही का इन-फ़्लाइट अनुरोध किया जाता है, तो वह अनुरोध उससे जुड़ जाता है.
onTokenChanged(appCheckInstance, Observer)	टोकन की स्थिति में बदलाव होने पर, लिसनर को रजिस्टर करता है. ऐप्लिकेशन की जांच के एक या एक से ज़्यादा इंस्टेंस के लिए, एक बार में एक से ज़्यादा लिसनर रजिस्टर किए जा सकते हैं. जब भी इस ऐप्लिकेशन चेक इंस्टेंस से जुड़े मौजूदा टोकन में बदलाव होता है, तब लिसनर यूज़र इंटरफ़ेस (यूआई) थ्रेड पर वापस कॉल करते हैं.
onTokenChanged(appCheckInstance, onNext, onError, oncomplete)	टोकन की स्थिति में बदलाव होने पर, लिसनर को रजिस्टर करता है. ऐप्लिकेशन की जांच के एक या एक से ज़्यादा इंस्टेंस के लिए, एक बार में एक से ज़्यादा लिसनर रजिस्टर किए जा सकते हैं. जब भी इस ऐप्लिकेशन चेक इंस्टेंस से जुड़े मौजूदा टोकन में बदलाव होता है, तब लिसनर यूज़र इंटरफ़ेस (यूआई) थ्रेड पर वापस कॉल करते हैं.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)	सेट करें कि ऐप्लिकेशन की जांच, ज़रूरत के हिसाब से टोकन को अपने-आप रीफ़्रेश करेगी या नहीं.

क्लास

क्लास	ब्यौरा
कस्टम प्रोवाइडर	पसंद के मुताबिक सेवा देने वाली कंपनी की क्लास.
ReCaptchaEnterpriseProvider	ऐप्लिकेशन चेक की सेवा देने वाली कंपनी, जो reCAPTCHA Enterprise टोकन पा सकती है और उसे ऐप्लिकेशन जांच टोकन से बदल सकती है.
ReCaptchaV3Provider	ऐप्लिकेशन चेक की सेवा देने वाली कंपनी, जो reCAPTCHA V3 टोकन पा सकती है और उसे ऐप्लिकेशन जांच टोकन से बदल सकती है.

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
ऐप्लिकेशन की जांच	Firebase ऐप्लिकेशन जांच सेवा का इंटरफ़ेस.
AppCheckOptions	ऐप्लिकेशन की जांच शुरू करने के विकल्प.
AppCheckToken	ऐप्लिकेशन चेक की सेवा देने वाली कंपनी से मिला टोकन.
AppCheckTokenresults	getToken() तक नतीजा मिला.
CustomProviderOptions	CustomProvider बनाते समय उपलब्ध विकल्प.

उपनामों का प्रकार

उपनाम टाइप करें	ब्यौरा
AppCheckTokenListener	ऐप्लिकेशन चेक टोकन में बदलाव होने पर, लिसनर को कॉल किया जाता है.

फ़ंक्शन(ऐप्लिकेशन, ...)

इनिशलाइज़ ऐप चेक(ऐप्लिकेशन, विकल्प)

दिए गए ऐप्लिकेशन के लिए, App Check की सुविधा चालू करें. हर ऐप्लिकेशन के लिए सिर्फ़ एक बार कॉल किया जा सकता है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	FirebaseApp | तय नहीं है	FirebaseApp का इस्तेमाल करके,
विकल्प	AppCheckOptions	ऐप्लिकेशन की जांच शुरू करने के विकल्प

लौटाए जाने वाले प्रॉडक्ट:

ऐप्लिकेशन की जांच

फ़ंक्शन(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Firebase ऐप्लिकेशन जांच टोकन का अनुरोध करता है. इस तरीके का इस्तेमाल सिर्फ़ तब किया जाना चाहिए, जब आपको किसी गैर-Firebase बैकएंड के लिए अनुरोधों को अनुमति देनी हो.

यह सीमित इस्तेमाल वाले ऐसे टोकन दिखाता है जिन्हें Firebase के अलावा, अन्य बैकएंड एंडपॉइंट के साथ इस्तेमाल किया जाता है. ये एंडपॉइंट, फिर से चलाने की सुरक्षा से सुरक्षित किए जाते हैं. #getAppCheckToken() तरीके के टोकन जनरेशन के व्यवहार पर इस तरीके का कोई असर नहीं पड़ता है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐपचेकइंस्टेंस	ऐप्लिकेशन की जांच	ऐप्लिकेशन जांच सेवा इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<AppCheckTokenresults>

सीमित इस्तेमाल के लिए टोकन.

getToken(appCheckInstance, forceRefresh)

मौजूदा ऐप्लिकेशन चेक टोकन पाएं. अगर forceRefresh गलत है, तो यह फ़ंक्शन पहले मेमोरी में किसी मान्य टोकन की जांच करता है. इसके बाद, लोकल परसिस्टेंस (IndexedDB) का पता चलता है. अगर उपयोगकर्ता की जानकारी नहीं मिलती है या forceRefresh सही है, तो यह ऐप्लिकेशन की जांच वाले एंडपॉइंट पर नए टोकन का अनुरोध करता है. अगर कोई हाल ही का इन-फ़्लाइट अनुरोध किया जाता है, तो वह अनुरोध उससे जुड़ जाता है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐपचेकइंस्टेंस	ऐप्लिकेशन की जांच	ऐप्लिकेशन जांच सेवा इंस्टेंस.
फ़ोर्सरीफ़्रेश करें	बूलियन	अगर सही है, तो हमेशा नया टोकन फ़ेच करने की कोशिश की जाएगी. गलत होने पर, स्टोरेज में मिलने पर कैश मेमोरी में सेव किया गया टोकन इस्तेमाल किया जाएगा.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<AppCheckTokenresults>

onTokenChanged(appCheckInstance, Observer)

टोकन की स्थिति में बदलाव होने पर, लिसनर को रजिस्टर करता है. ऐप्लिकेशन की जांच के एक या एक से ज़्यादा इंस्टेंस के लिए, एक बार में एक से ज़्यादा लिसनर रजिस्टर किए जा सकते हैं. जब भी इस ऐप्लिकेशन चेक इंस्टेंस से जुड़े मौजूदा टोकन में बदलाव होता है, तब लिसनर यूज़र इंटरफ़ेस (यूआई) थ्रेड पर वापस कॉल करते हैं.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐपचेकइंस्टेंस	ऐप्लिकेशन की जांच	ऐप्लिकेशन जांच सेवा इंस्टेंस.
ऑब्ज़र्वर	पार्स ऑब्ज़र्वर<AppCheckTokenresults>	next, error, और complete प्रॉपर्टी वाला एक ऑब्जेक्ट. जब भी टोकन बदलता है, तब next को AppCheckTokenresults के साथ कॉल किया जाता है. error ज़रूरी नहीं है. इसे तब कॉल किया जाता है, जब सुनने वाले व्यक्ति (next फ़ंक्शन) की वजह से कोई गड़बड़ी होती है. टोकन स्ट्रीम खत्म नहीं होने की वजह से, complete का इस्तेमाल नहीं किया जा रहा है.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

इस लिसनर की सदस्यता छोड़ने का फ़ंक्शन.

onTokenChanged(appCheckInstance, onNext, onError, oncomplete)

टोकन की स्थिति में बदलाव होने पर, लिसनर को रजिस्टर करता है. ऐप्लिकेशन की जांच के एक या एक से ज़्यादा इंस्टेंस के लिए, एक बार में एक से ज़्यादा लिसनर रजिस्टर किए जा सकते हैं. जब भी इस ऐप्लिकेशन चेक इंस्टेंस से जुड़े मौजूदा टोकन में बदलाव होता है, तब लिसनर यूज़र इंटरफ़ेस (यूआई) थ्रेड पर वापस कॉल करते हैं.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐपचेकइंस्टेंस	ऐप्लिकेशन की जांच	ऐप्लिकेशन जांच सेवा इंस्टेंस.
अगला	(tokenनतीजे: AppCheckTokenresults) => अमान्य	टोकन में बदलाव होने पर, इस फ़ंक्शन को AppCheckTokenresults के साथ कॉल किया जाता है.
ऑन एरर	(गड़बड़ी: गड़बड़ी) => अमान्य	ज़रूरी नहीं. इसे तब कॉल किया जाता है, जब सुनने वाले (onNext फ़ंक्शन) की वजह से कोई गड़बड़ी होती है.
पूरा होने पर	() => अमान्य	टोकन स्ट्रीम अभी इस्तेमाल नहीं की जा रही है, क्योंकि टोकन स्ट्रीम खत्म नहीं हो रही है.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

इस लिसनर की सदस्यता छोड़ने का फ़ंक्शन.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

सेट करें कि ऐप्लिकेशन की जांच, ज़रूरत के हिसाब से टोकन को अपने-आप रीफ़्रेश करेगी या नहीं.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐपचेकइंस्टेंस	ऐप्लिकेशन की जांच	ऐप्लिकेशन जांच सेवा इंस्टेंस.
isTokenAutoRefreshEnabled	बूलियन	सही होने पर, SDK टूल ज़रूरत के हिसाब से App Check टोकन को अपने-आप रीफ़्रेश कर देता है. यह initializeAppCheck() के दौरान सेट की गई किसी भी वैल्यू को बदल देता है.

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

AppCheckTokenListener

ऐप्लिकेशन चेक टोकन में बदलाव होने पर, लिसनर को कॉल किया जाता है.

हस्ताक्षर:

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