app-check package

फायरबेस ऐप वेब एसडीके की जांच करता है।

ReCaptchaV3Provider या ReCaptchaEnterpriseProvider उपयोग करके Node.js वातावरण में फायरबेस ऐप चेक काम नहीं करता है , लेकिन यदि आप CustomProvider उपयोग करते हैं और अपनी स्वयं की सत्यापन विधि लिखते हैं तो इसका उपयोग Node.js में किया जा सकता है।

कार्य

कक्षाओं

इंटरफेस

उपनाम टाइप करें

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

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

दिए गए ऐप के लिए ऐप चेक सक्रिय करें। प्रति ऐप केवल एक बार कॉल किया जा सकता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

ऐपचेक

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

getLimitedUseToken(appCheckInstance)

फायरबेस ऐप चेक टोकन का अनुरोध करता है। इस पद्धति का उपयोग केवल तभी किया जाना चाहिए जब आपको गैर-फ़ायरबेस बैकएंड के लिए अनुरोधों को अधिकृत करने की आवश्यकता हो।

सीमित-उपयोग वाले टोकन लौटाता है जो आपके गैर-फ़ायरबेस बैकएंड एंडपॉइंट के साथ उपयोग के लिए हैं जो रीप्ले प्रोटेक्शन से सुरक्षित हैं। यह विधि #getAppCheckToken() विधि के टोकन निर्माण व्यवहार को प्रभावित नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< AppCheckTokenResult >

सीमित उपयोग टोकन.

getToken(appCheckInstance, ForceRefresh)

वर्तमान ऐप चेक टोकन प्राप्त करें। यदि कोई मौजूद है तो नवीनतम इन-फ्लाइट अनुरोध को संलग्न करता है। यदि कोई टोकन मौजूद नहीं है और उड़ान के दौरान कोई टोकन अनुरोध नहीं है, तो शून्य लौटाता है।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

वादा< AppCheckTokenResult >

onTokenChanged(appCheckInstance, पर्यवेक्षक)

टोकन स्थिति में परिवर्तन के लिए श्रोता को पंजीकृत करता है। एक या अधिक ऐप चेक इंस्टेंसेस के लिए एक ही समय में एक से अधिक श्रोता पंजीकृत हो सकते हैं। जब भी इस ऐप चेक इंस्टेंस से जुड़ा वर्तमान टोकन बदलता है तो श्रोता यूआई थ्रेड पर वापस कॉल करते हैं।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

सदस्यता रद्द

एक फ़ंक्शन जो इस श्रोता की सदस्यता समाप्त करता है।

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

टोकन स्थिति में परिवर्तन के लिए श्रोता को पंजीकृत करता है। एक या अधिक ऐप चेक इंस्टेंसेस के लिए एक ही समय में एक से अधिक श्रोता पंजीकृत हो सकते हैं। जब भी इस ऐप चेक इंस्टेंस से जुड़ा वर्तमान टोकन बदलता है तो श्रोता यूआई थ्रेड पर वापस कॉल करते हैं।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

सदस्यता रद्द

एक फ़ंक्शन जो इस श्रोता की सदस्यता समाप्त करता है।

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

सेट करें कि क्या ऐप चेक आवश्यकतानुसार स्वचालित रूप से टोकन रीफ्रेश करेगा।

हस्ताक्षर:

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

पैरामीटर

रिटर्न:

खालीपन

AppCheckTokenListener

एक श्रोता जिसे ऐप चेक टोकन बदलने पर कॉल किया जाता है।

हस्ताक्षर:

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