app-check package

Firebase App Check Web SDK.

Firebase App Check לא עובד בסביבת Node.js באמצעות ReCaptchaV3Provider או ReCaptchaEnterpriseProvider , אך ניתן להשתמש בו ב-Node.js אם אתה משתמש CustomProvider וכותב שיטת אישור משלך.

פונקציות

פוּנקצִיָה	תיאור
פונקציה (אפליקציה,...)
initializeAppCheck (אפליקציה, אפשרויות)	הפעל את App Check עבור האפליקציה הנתונה. ניתן להתקשר רק פעם אחת בכל אפליקציה.
function (appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)	מבקש אסימון בדיקת אפליקציה של Firebase. יש להשתמש בשיטה זו רק אם אתה צריך לאשר בקשות ל-backend שאינו Firebase. מחזיר אסימונים לשימוש מוגבל המיועדים לשימוש עם נקודות הקצה האחוריות שאינן של Firebase המוגנות באמצעות Replay Protection . שיטה זו אינה משפיעה על התנהגות יצירת האסימונים של שיטת #getAppCheckToken()‎.
getToken(appCheckInstance, forceRefresh)	קבל את אסימון App Check הנוכחי. מצורף לבקשה האחרונה בטיסה אם קיימת כזו. מחזירה null אם אין אסימון ואין בקשות אסימון במהלך הטיסה.
onTokenChanged(appCheckInstance, observer)	רושם מאזין לשינויים במצב האסימון. יכול להיות יותר ממאזין אחד רשום בו-זמנית עבור מופע App Check אחד או יותר. המאזינים מתקשרים בחזרה בשרשור ממשק המשתמש בכל פעם שהאסימון הנוכחי המשויך למופע App Check זה משתנה.
onTokenChanged(appCheckInstance, onNext, onError, onCompletion)	רושם מאזין לשינויים במצב האסימון. יכול להיות יותר ממאזין אחד רשום בו-זמנית עבור מופע App Check אחד או יותר. המאזינים מתקשרים בחזרה בשרשור ממשק המשתמש בכל פעם שהאסימון הנוכחי המשויך למופע App Check זה משתנה.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)	קבע אם App Check ירענן אוטומטית אסימונים לפי הצורך.

שיעורים

מעמד	תיאור
ספק מותאם אישית	שיעור ספק מותאם אישית.
ReCaptchaEnterpriseProvider	ספק בדיקת אפליקציות שיכול להשיג אסימון reCAPTCHA Enterprise ולהחליף אותו באסימון App Check.
ReCaptchaV3Provider	ספק בדיקת אפליקציות שיכול להשיג אסימון reCAPTCHA V3 ולהחליף אותו באסימון App Check.

ממשקים

מִמְשָׁק	תיאור
AppCheck	ממשק שירות Firebase App Check.
AppCheckOptions	אפשרויות לאתחול App Check.
AppCheckToken	האסימון הוחזר מספק App Check.
AppCheckTokenResult	התוצאה הוחזרה על ידי getToken() .
CustomProviderOptions	אפשרויות בעת יצירת CustomProvider .

הקלד כינויים

הקלד כינוי	תיאור
AppCheckTokenListener	מאזין שנקרא בכל פעם שהאסימון App Check משתנה.

פונקציה (אפליקציה,...)

initializeAppCheck (אפליקציה, אפשרויות)

הפעל את App Check עבור האפליקציה הנתונה. ניתן להתקשר רק פעם אחת בכל אפליקציה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
אפליקציה	FirebaseApp | לא מוגדר	את FirebaseApp כדי להפעיל את App Check for
אפשרויות	AppCheckOptions	אפליקציה בדוק אפשרויות אתחול

החזרות:

AppCheck

function (appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

מבקש אסימון בדיקת אפליקציה של Firebase. יש להשתמש בשיטה זו רק אם אתה צריך לאשר בקשות ל-backend שאינו Firebase.

מחזיר אסימונים לשימוש מוגבל המיועדים לשימוש עם נקודות הקצה האחוריות שאינן של Firebase המוגנות באמצעות Replay Protection . שיטה זו אינה משפיעה על התנהגות יצירת האסימונים של שיטת #getAppCheckToken()‎.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
appCheckInstance	AppCheck	מופע שירות App Check.

החזרות:

הבטחה< AppCheckTokenResult >

אסימון השימוש המוגבל.

getToken(appCheckInstance, forceRefresh)

קבל את אסימון App Check הנוכחי. מצורף לבקשה האחרונה בטיסה אם קיימת כזו. מחזירה null אם אין אסימון ואין בקשות אסימון במהלך הטיסה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
appCheckInstance	AppCheck	מופע שירות App Check.
כוחRefresh	בוליאני	אם זה נכון, תמיד ינסה להביא אסימון חדש. אם false, ישתמש באסימון שמור אם יימצא באחסון.

החזרות:

הבטחה< AppCheckTokenResult >

onTokenChanged(appCheckInstance, observer)

רושם מאזין לשינויים במצב האסימון. יכול להיות יותר ממאזין אחד רשום בו-זמנית עבור מופע App Check אחד או יותר. המאזינים מתקשרים בחזרה בשרשור ממשק המשתמש בכל פעם שהאסימון הנוכחי המשויך למופע App Check זה משתנה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
appCheckInstance	AppCheck	מופע שירות App Check.
מַשׁקִיף	PartialObserver < AppCheckTokenResult >	אובייקט עם מאפיינים next , error complete . next נקרא עם AppCheckTokenResult בכל פעם שהאסימון משתנה. error היא אופציונלית ונקראת אם שגיאה נזרקת על ידי המאזין (הפונקציה next ). complete אינו בשימוש, מכיוון שזרם האסימונים אינו נגמר.

החזרות:

בטל את המנוי

פונקציה שמבטלת את המנוי של המאזין הזה.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

רושם מאזין לשינויים במצב האסימון. יכול להיות יותר ממאזין אחד רשום בו-זמנית עבור מופע App Check אחד או יותר. המאזינים מתקשרים בחזרה בשרשור ממשק המשתמש בכל פעם שהאסימון הנוכחי המשויך למופע App Check זה משתנה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
appCheckInstance	AppCheck	מופע שירות App Check.
בהבא	(tokenResult: AppCheckTokenResult ) => בטל	כאשר האסימון משתנה, פונקציה זו נקראת עם AppCheckTokenResult .
onError	(שגיאה: שגיאה) => ריק	אופציונאלי. נקרא אם יש שגיאה שנזרקה על ידי המאזין (פונקציית 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

מאזין שנקרא בכל פעם שהאסימון App Check משתנה.

חֲתִימָה:

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