تطبيق Firebase للتحقق من Web SDK.
لا يعمل Firebase App Check في بيئة Node.js باستخدام ReCaptchaV3Provider أو ReCaptchaEnterpriseProvider ، ولكن يمكن استخدامه في Node.js إذا كنت تستخدم CustomProvider وتكتب طريقة التصديق الخاصة بك.
المهام
| وظيفة | وصف |
|---|---|
| وظيفة (التطبيق، ...) | |
| تهيئةAppCheck (التطبيق، الخيارات) | تنشيط التحقق من التطبيق للتطبيق المحدد. يمكن الاتصال به مرة واحدة فقط لكل تطبيق. |
| وظيفة (appCheckInstance، ...) | |
| getLimitedUseToken(appCheckInstance) | يطلب رمز التحقق من تطبيق Firebase. يجب استخدام هذه الطريقة فقط إذا كنت بحاجة إلى السماح بالطلبات إلى واجهة خلفية غير تابعة لـ Firebase. إرجاع الرموز المميزة ذات الاستخدام المحدود والمخصصة للاستخدام مع نقاط النهاية الخلفية غير التابعة لـ Firebase والمحمية باستخدام Replay Protection . لا تؤثر هذه الطريقة على سلوك إنشاء الرمز المميز للطريقة #getAppCheckToken(). |
| getToken(appCheckInstance, forceRefresh) | احصل على رمز التحقق من التطبيق الحالي. يتم إرفاقه بأحدث طلب على متن الطائرة في حالة وجوده. يتم إرجاع قيمة فارغة في حالة عدم وجود رمز مميز وعدم وجود طلبات رمزية أثناء الرحلة. |
| onTokenChanged(appCheckInstance، المراقب) | يسجل المستمع للتغييرات في حالة الرمز المميز. يمكن أن يكون هناك أكثر من مستمع مسجل في نفس الوقت لواحد أو أكثر من مثيلات التحقق من التطبيق. يقوم المستمعون بالاتصال مرة أخرى بسلسلة واجهة المستخدم عندما يتغير الرمز المميز الحالي المرتبط بمثيل التحقق من التطبيق هذا. |
| onTokenChanged(appCheckInstance، onNext، onError، onCompletion) | يسجل المستمع للتغييرات في حالة الرمز المميز. يمكن أن يكون هناك أكثر من مستمع مسجل في نفس الوقت لواحد أو أكثر من مثيلات التحقق من التطبيق. يقوم المستمعون بالاتصال مرة أخرى بسلسلة واجهة المستخدم عندما يتغير الرمز المميز الحالي المرتبط بمثيل التحقق من التطبيق هذا. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | قم بتعيين ما إذا كان التحقق من التطبيق سيقوم بتحديث الرموز المميزة تلقائيًا حسب الحاجة. |
الطبقات
| فصل | وصف |
|---|---|
| CustomProvider | فئة الموفر المخصص. |
| ReCaptchaEnterpriseProvider | موفر التحقق من التطبيق الذي يمكنه الحصول على رمز reCAPTCHA Enterprise واستبداله برمز التحقق من التطبيق. |
| ReCaptchaV3Provider | موفر خدمة التحقق من التطبيق الذي يمكنه الحصول على رمز reCAPTCHA V3 واستبداله برمز التحقق من التطبيق. |
واجهات
| واجهه المستخدم | وصف |
|---|---|
| التحقق من التطبيق | واجهة خدمة Firebase App Check. |
| خيارات التطبيق | خيارات لتهيئة التحقق من التطبيق. |
| AppCheckToken | تم إرجاع الرمز المميز من موفر التحقق من التطبيق. |
| AppCheckTokenResult | تم إرجاع النتيجة بواسطة getToken() . |
| CustomProviderOptions | الخيارات عند إنشاء CustomProvider . |
اكتب الأسماء المستعارة
| اكتب الاسم المستعار | وصف |
|---|---|
| AppCheckTokenListener | مستمع يتم استدعاؤه عندما يتغير رمز التحقق من التطبيق. |
وظيفة (التطبيق، ...)
تهيئةAppCheck (التطبيق، الخيارات)
تنشيط التحقق من التطبيق للتطبيق المحدد. يمكن الاتصال به مرة واحدة فقط لكل تطبيق.
إمضاء:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| برنامج | FirebaseApp | غير معرف | FirebaseApp لتنشيط التحقق من التطبيق |
| خيارات | خيارات التطبيق | خيارات تهيئة التحقق من التطبيق |
عائدات:
وظيفة (appCheckInstance، ...)
getLimitedUseToken(appCheckInstance)
يطلب رمز التحقق من تطبيق Firebase. يجب استخدام هذه الطريقة فقط إذا كنت بحاجة إلى السماح بالطلبات إلى واجهة خلفية غير تابعة لـ Firebase.
إرجاع الرموز المميزة ذات الاستخدام المحدود والمخصصة للاستخدام مع نقاط النهاية الخلفية غير التابعة لـ Firebase والمحمية باستخدام Replay Protection . لا تؤثر هذه الطريقة على سلوك إنشاء الرمز المميز للطريقة #getAppCheckToken().
إمضاء:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| appCheckInstance | التحقق من التطبيق | مثيل خدمة التحقق من التطبيق. |
عائدات:
وعد< AppCheckTokenResult >
رمز الاستخدام المحدود.
getToken(appCheckInstance, forceRefresh)
احصل على رمز التحقق من التطبيق الحالي. يتم إرفاقه بأحدث طلب على متن الطائرة في حالة وجوده. يتم إرجاع قيمة فارغة في حالة عدم وجود رمز مميز وعدم وجود طلبات رمزية أثناء الرحلة.
إمضاء:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| appCheckInstance | التحقق من التطبيق | مثيل خدمة التحقق من التطبيق. |
| forceRefresh | منطقية | إذا كان هذا صحيحًا، فسوف نحاول دائمًا جلب رمز مميز جديد. إذا كان خطأ، سيتم استخدام رمز مميز مخبأ إذا تم العثور عليه في التخزين. |
عائدات:
وعد< AppCheckTokenResult >
onTokenChanged(appCheckInstance، المراقب)
يسجل المستمع للتغييرات في حالة الرمز المميز. يمكن أن يكون هناك أكثر من مستمع مسجل في نفس الوقت لواحد أو أكثر من مثيلات التحقق من التطبيق. يقوم المستمعون بالاتصال مرة أخرى بسلسلة واجهة المستخدم عندما يتغير الرمز المميز الحالي المرتبط بمثيل التحقق من التطبيق هذا.
إمضاء:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| appCheckInstance | التحقق من التطبيق | مثيل خدمة التحقق من التطبيق. |
| مراقب | PartialObserver < AppCheckTokenResult > | كائن ذو الخصائص next error complete . يتم استدعاء next باستخدام AppCheckTokenResult عندما يتغير الرمز المميز. error اختياري ويتم استدعاؤه إذا أخطأ المستمع (الوظيفة next ). complete غير مستخدم، لأن دفق الرمز المميز لا ينتهي. |
عائدات:
وظيفة تقوم بإلغاء اشتراك هذا المستمع.
onTokenChanged(appCheckInstance، onNext، onError، onCompletion)
يسجل المستمع للتغييرات في حالة الرمز المميز. يمكن أن يكون هناك أكثر من مستمع مسجل في نفس الوقت لواحد أو أكثر من مثيلات التحقق من التطبيق. يقوم المستمعون بالاتصال مرة أخرى بسلسلة واجهة المستخدم عندما يتغير الرمز المميز الحالي المرتبط بمثيل التحقق من التطبيق هذا.
إمضاء:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| appCheckInstance | التحقق من التطبيق | مثيل خدمة التحقق من التطبيق. |
| على التالي | (tokenResult: AppCheckTokenResult ) => باطل | عندما يتغير الرمز المميز، يتم استدعاء هذه الوظيفة باستخدام AppCheckTokenResult . |
| خطأ | (خطأ: خطأ) => باطل | خياري. يتم استدعاؤه إذا حدث خطأ من قبل المستمع (وظيفة onNext ). |
| على الانتهاء | () => باطل | غير مستخدم حاليًا، نظرًا لأن دفق الرمز المميز لا ينتهي. |
عائدات:
وظيفة تقوم بإلغاء اشتراك هذا المستمع.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
قم بتعيين ما إذا كان التحقق من التطبيق سيقوم بتحديث الرموز المميزة تلقائيًا حسب الحاجة.
إمضاء:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| appCheckInstance | التحقق من التطبيق | مثيل خدمة التحقق من التطبيق. |
| isTokenAutoRefreshEnabled | منطقية | إذا كان هذا صحيحًا، تقوم SDK تلقائيًا بتحديث الرموز المميزة للتحقق من التطبيق حسب الحاجة. يؤدي هذا إلى تجاوز أي قيمة تم تعيينها أثناء initializeAppCheck() . |
عائدات:
فارغ
AppCheckTokenListener
مستمع يتم استدعاؤه عندما يتغير رمز التحقق من التطبيق.
إمضاء:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;