app-check package

حزمة تطوير البرامج (SDK) الخاصة بأداة فحص التطبيقات على الويب من Firebase

لا تعمل ميزة "التحقّق من التطبيقات من Firebase" في بيئة Node.js باستخدام ReCaptchaV3Provider أو ReCaptchaEnterpriseProvider، ولكن يمكن استخدامها في Node.js إذا كنت تستخدم CustomProvider وكتابة طريقة المصادقة الخاصة بك.

الدوال

دالة	الوصف
الدالّة(app, ...)
تعريف AppCheck(app, options)	تفعيل ميزة "التحقّق من التطبيقات" للتطبيق المحدّد يمكن طلبها مرة واحدة فقط لكل تطبيق.
الدالّة(appCheckInstance, ...)
getlimitedUseToken(appCheckInstance)	تطلب رمزًا مميزًا لفحص التطبيقات في Firebase. يجب عدم استخدام هذه الطريقة إلّا إذا كنت بحاجة إلى السماح بالطلبات في خلفية غير تابعة لمنصة Firebase.يعرض هذا الخيار الرموز المميزة ذات الاستخدام المحدود والمخصّصة للاستخدام مع نقاط النهاية غير التابعة لـ Firebase والمحمية باستخدام ميزة حماية إعادة التشغيل. لا تؤثر هذه الطريقة في سلوك إنشاء الرمز المميز لطريقة #getAppCheckToken() .
getToken(appCheckInstance, forceRefresh)	يمكنك الحصول على الرمز المميّز الحالي لفحص التطبيقات. إذا كانت قيمة forceRefresh غير صحيحة، تتحقّق هذه الدالة أولاً من رمز مميّز صالح في الذاكرة، ثم تتحقّق من الثبات المحلي (IndexedDB). في حال عدم العثور على الرمز أو ضبط forceRefresh على "صحيح"، سيتم إرسال طلب إلى نقطة نهاية "التحقّق من التطبيقات" للحصول على رمز مميّز جديد. ويتم إرفاق هذا الطلب بأحدث طلب قيد التشغيل، في حال توفّره.
onTokenChanged(appCheckInstance, Monitoringr)	لتسجيل أداة استماع للتغييرات في حالة الرمز المميز. يمكن تسجيل أكثر من مستمع واحد في الوقت نفسه لعملية واحدة أو أكثر من حالات "التحقّق من التطبيق". يتصل المستمعون مرة أخرى في سلسلة واجهة المستخدم عند تغيير الرمز المميّز الحالي المرتبط بمثيل "التحقّق من التطبيق".
onTokenChanged(appCheckInstance, onNext, onError, onComplete)	لتسجيل أداة استماع للتغييرات في حالة الرمز المميز. يمكن تسجيل أكثر من مستمع واحد في الوقت نفسه لعملية واحدة أو أكثر من حالات "التحقّق من التطبيق". يتصل المستمعون مرة أخرى في سلسلة واجهة المستخدم عند تغيير الرمز المميّز الحالي المرتبط بمثيل "التحقّق من التطبيق".
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)	حدِّد ما إذا كانت ميزة "فحص التطبيق" ستعمل تلقائيًا على إعادة تحميل الرموز المميّزة حسب الحاجة.

صفوف

الفئة	الوصف
CustomProvider	فئة مقدِّم خدمة مخصَّصة.
ReCaptchaEnterpriseProvider	موفِّر خدمة "التحقّق من التطبيقات" الذي يمكنه الحصول على رمز مميَّز لـ reCAPTCHA Enterprise واستبداله برمز مميّز لميزة "التحقّق من التطبيقات"
ReCaptchaV3Provider	موفِّر خدمة "التحقّق من التطبيقات" الذي يمكنه الحصول على رمز مميَّز لـ reCAPTCHA V3 واستبداله برمز مميّز لميزة "التحقّق من التطبيقات"

واجهات

الواجهة	الوصف
فحص التطبيقات	واجهة خدمة "التحقّق من التطبيقات" في Firebase
AppCheckOptions	خيارات إعداد ميزة "التحقق من التطبيقات"
رمز AppCheckToken	الرمز المميّز الذي تم عرضه من موفِّر خدمة "التحقّق من التطبيقات"
AppCheckTokenResult	تم عرض النتيجة من قِبل "getToken()".
CustomProviderOptions	الخيارات عند إنشاء CustomProvider.

كتابة العناوين البديلة للبريد الإلكتروني

اكتب العنوان البديل للبريد الإلكتروني	الوصف
AppCheckTokenListener	مستمع يتم استدعاءه عند تغيير الرمز المميز "فحص التطبيق".

function(app, ...)

startizeAppCheck(app, options)

تفعيل ميزة "التحقّق من التطبيقات" للتطبيق المحدّد يمكن طلبها مرة واحدة فقط لكل تطبيق.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
التطبيق	FirebaseApp | غير محدّدة	FirebaseApp لتفعيل ميزة "فحص التطبيقات"
خيارات	AppCheckOptions	خيارات إعداد "فحص التطبيقات"

المرتجعات:

فحص التطبيقات

function(appCheckInstance, ...)

getlimitedUseToken(appCheckInstance)

تطلب رمزًا مميزًا لفحص التطبيقات في Firebase. يجب عدم استخدام هذه الطريقة إلّا إذا كنت بحاجة إلى السماح بالطلبات إلى خلفية غير تابعة لمنصة Firebase.

عرض الرموز المميّزة ذات الاستخدام المحدود والمخصّصة للاستخدام مع نقاط النهاية غير الصادرة عن Firebase والمحمية باستخدام ميزة حماية إعادة التشغيل. لا تؤثر هذه الطريقة في سلوك إنشاء الرمز المميز لطريقة #getAppCheckToken() .

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
مثيل appCheckInstance	فحص التطبيقات	مثيل خدمة "فحص التطبيقات"

المرتجعات:

Promise<AppCheckTokenResult>

الرمز المميّز للاستخدام المحدود

getToken(appCheckInstance, forceRefresh)

يمكنك الحصول على الرمز المميّز الحالي لفحص التطبيقات. إذا كانت قيمة forceRefresh غير صحيحة، تتحقّق هذه الدالة أولاً من رمز مميّز صالح في الذاكرة، ثم تتحقّق من الثبات المحلي (IndexedDB). في حال عدم العثور على الرمز أو ضبط forceRefresh على "صحيح"، سيتم إرسال طلب إلى نقطة نهاية "التحقّق من التطبيقات" للحصول على رمز مميّز جديد. ويتم إرفاق هذا الطلب بأحدث طلب قيد التشغيل، في حال توفّره.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
مثيل appCheckInstance	فحص التطبيقات	مثيل خدمة "فحص التطبيقات"
فرض إعادة التحميل	قيمة منطقية	إذا كانت القيمة هي true، ستحاول دائمًا استرجاع رمز مميّز جديد. في حال القيمة "false"، سيتم استخدام رمز مميّز مخزَّن مؤقتًا في حال العثور عليه في مساحة التخزين.

المرتجعات:

Promise<AppCheckTokenResult>

onTokenChanged(appCheckInstance, Monitoringr)

لتسجيل أداة استماع للتغييرات في حالة الرمز المميز. يمكن تسجيل أكثر من مستمع واحد في الوقت نفسه لعملية واحدة أو أكثر من حالات "التحقّق من التطبيق". يتصل المستمعون مرة أخرى في سلسلة واجهة المستخدم عند تغيير الرمز المميّز الحالي المرتبط بمثيل "التحقّق من التطبيق".

Signature:

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, onComplete)

لتسجيل أداة استماع للتغييرات في حالة الرمز المميز. يمكن تسجيل أكثر من مستمع واحد في الوقت نفسه لعملية واحدة أو أكثر من حالات "التحقّق من التطبيق". يتصل المستمعون مرة أخرى في سلسلة واجهة المستخدم عند تغيير الرمز المميّز الحالي المرتبط بمثيل "التحقّق من التطبيق".

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
مثيل appCheckInstance	فحص التطبيقات	مثيل خدمة "فحص التطبيقات"
علىالتالي	(tokenResult: AppCheckTokenResult) => فراغ	عندما يتغيّر الرمز المميّز، يتم استدعاء هذه الدالة باستخدام AppCheckTokenResult.
onError	(خطأ: خطأ) => فراغ	هذه السمة اختيارية. يتم استدعاء هذا الإجراء إذا حدث خطأ من جانب المستمع (دالة onNext).
عند الاكتمال	() => فراغ	هذا الرمز غير مُستخدَم حاليًا، لأنّ تدفق الرمز المميّز لا ينتهي.

المرتجعات:

إلغاء الاشتراك

دالة تلغي الاشتراك في خدمة هذا المستمع.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

حدِّد ما إذا كانت ميزة "فحص التطبيق" ستعمل تلقائيًا على إعادة تحميل الرموز المميّزة حسب الحاجة.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
مثيل appCheckInstance	فحص التطبيقات	مثيل خدمة "فحص التطبيقات"
isTokenAutoRefreshEnabled	قيمة منطقية	في حال الضبط على "صحيح"، تُعيد حزمة تطوير البرامج (SDK) تلقائيًا رموز "فحص التطبيقات" المميَّزة حسب الحاجة. يؤدي هذا الإجراء إلى إلغاء أي قيمة تم تحديدها خلال initializeAppCheck().

المرتجعات:

فراغ

AppCheckTokenListener

مستمع يتم استدعاءه عند تغيير الرمز المميز "فحص التطبيق".

Signature:

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