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