แอป Firebase ตรวจสอบเว็บ SDK
Firebase App Check ไม่ทำงานในสภาพแวดล้อม Node.js โดยใช้ ReCaptchaV3Provider
หรือ ReCaptchaEnterpriseProvider
แต่สามารถใช้ได้ใน Node.js หากคุณใช้ CustomProvider
และเขียนวิธีการรับรองของคุณเอง
ฟังก์ชั่น
การทำงาน | คำอธิบาย |
---|---|
ฟังก์ชั่น(แอพ, ...) | |
เตรียมใช้งาน AppCheck (แอพ ตัวเลือก) | เปิดใช้งาน App Check สำหรับแอปที่กำหนด สามารถเรียกได้เพียงครั้งเดียวต่อแอป |
ฟังก์ชั่น (appCheckInstance, ... ) | |
getLimitedUseToken (แอป CheckInstance) | ขอโทเค็น Firebase App Check ควรใช้วิธีนี้เฉพาะเมื่อคุณต้องการอนุญาตคำขอไปยังแบ็กเอนด์ที่ไม่ใช่ Firebase ส่งคืนโทเค็นการใช้งานแบบจำกัดที่มีไว้สำหรับใช้กับปลายทางแบ็กเอนด์ที่ไม่ใช่ Firebase ซึ่งได้รับการปกป้องด้วย Replay Protection เมธอดนี้ไม่ส่งผลต่อพฤติกรรมการสร้างโทเค็นของเมธอด #getAppCheckToken() |
getToken (appCheckInstance, บังคับให้รีเฟรช) | รับโทเค็น App Check ปัจจุบัน แนบไปกับคำขอในเที่ยวบินล่าสุด หากมีอยู่ ส่งคืนค่าว่างหากไม่มีโทเค็นและไม่มีคำขอโทเค็นอยู่ระหว่างดำเนินการ |
onTokenChanged (appCheckInstance ผู้สังเกตการณ์) | ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น สามารถลงทะเบียน Listener ได้มากกว่าหนึ่งรายการพร้อมกันสำหรับอินสแตนซ์ App Check หนึ่งรายการขึ้นไป ผู้ฟังจะโทรกลับมาที่เธรด UI ทุกครั้งที่โทเค็นปัจจุบันที่เกี่ยวข้องกับอินสแตนซ์ App Check นี้เปลี่ยนแปลง |
onTokenChanged (appCheckInstance, onNext, onError, onCompletion) | ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น สามารถลงทะเบียน Listener ได้มากกว่าหนึ่งรายการพร้อมกันสำหรับอินสแตนซ์ App Check หนึ่งรายการขึ้นไป ผู้ฟังจะโทรกลับมาที่เธรด UI ทุกครั้งที่โทเค็นปัจจุบันที่เกี่ยวข้องกับอินสแตนซ์ App Check นี้เปลี่ยนแปลง |
setTokenAutoRefreshEnabled (appCheckInstance, isTokenAutoRefreshEnabled) | ตั้งค่าว่า App Check จะรีเฟรชโทเค็นโดยอัตโนมัติตามความจำเป็นหรือไม่ |
ชั้นเรียน
ระดับ | คำอธิบาย |
---|---|
CustomProvider | คลาสผู้ให้บริการแบบกำหนดเอง |
ReCaptchaEnterpriseProvider | ผู้ให้บริการ App Check ที่สามารถรับโทเค็น reCAPTCHA Enterprise และแลกเปลี่ยนเป็นโทเค็น App Check |
ReCaptchaV3ผู้ให้บริการ | ผู้ให้บริการ App Check ที่สามารถรับโทเค็น reCAPTCHA V3 และแลกเป็นโทเค็น App Check |
อินเทอร์เฟซ
อินเตอร์เฟซ | คำอธิบาย |
---|---|
แอพเช็ค | อินเทอร์เฟซบริการ Firebase App Check |
AppCheckOptions | ตัวเลือกสำหรับการเริ่มต้น App Check |
AppCheckToken | โทเค็นที่ส่งคืนจากผู้ให้บริการ App Check |
ผลลัพธ์ AppCheckToken | ผลลัพธ์ที่ส่งคืนโดย getToken() |
ตัวเลือกผู้ให้บริการแบบกำหนดเอง | ตัวเลือกเมื่อสร้าง CustomProvider . |
พิมพ์นามแฝง
พิมพ์นามแฝง | คำอธิบาย |
---|---|
AppCheckTokenListener | Listener ที่ถูกเรียกทุกครั้งที่โทเค็น App Check เปลี่ยนแปลง |
ฟังก์ชั่น(แอพ, ...)
เตรียมใช้งาน AppCheck (แอพ ตัวเลือก)
เปิดใช้งาน App Check สำหรับแอปที่กำหนด สามารถเรียกได้เพียงครั้งเดียวต่อแอป
ลายเซ็น:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอป | FirebaseApp | ไม่ได้กำหนด | FirebaseApp เพื่อเปิดใช้งาน App Check for |
ตัวเลือก | AppCheckOptions | ตัวเลือกการเริ่มต้น App Check |
ผลตอบแทน:
ฟังก์ชั่น (appCheckInstance, ... )
getLimitedUseToken (แอป CheckInstance)
ขอโทเค็น Firebase App Check ควรใช้วิธีนี้เฉพาะเมื่อคุณต้องการอนุญาตคำขอไปยังแบ็กเอนด์ที่ไม่ใช่ Firebase
ส่งคืนโทเค็นการใช้งานแบบจำกัดที่มีไว้สำหรับใช้กับปลายทางแบ็กเอนด์ที่ไม่ใช่ Firebase ซึ่งได้รับการปกป้องด้วย Replay Protection เมธอดนี้ไม่ส่งผลต่อพฤติกรรมการสร้างโทเค็นของเมธอด #getAppCheckToken()
ลายเซ็น:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอพ CheckInstance | แอพเช็ค | อินสแตนซ์บริการ App Check |
ผลตอบแทน:
สัญญา < AppCheckTokenResult >
โทเค็นการใช้งานที่จำกัด
getToken (appCheckInstance, บังคับให้รีเฟรช)
รับโทเค็น App Check ปัจจุบัน แนบไปกับคำขอในเที่ยวบินล่าสุด หากมีอยู่ ส่งคืนค่าว่างหากไม่มีโทเค็นและไม่มีคำขอโทเค็นอยู่ระหว่างดำเนินการ
ลายเซ็น:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอพ CheckInstance | แอพเช็ค | อินสแตนซ์บริการ App Check |
บังคับรีเฟรช | บูลีน | หากเป็นจริง จะพยายามดึงโทเค็นใหม่เสมอ หากเป็นเท็จ จะใช้โทเค็นแคชหากพบในที่เก็บข้อมูล |
ผลตอบแทน:
สัญญา < AppCheckTokenResult >
onTokenChanged (appCheckInstance ผู้สังเกตการณ์)
ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น สามารถลงทะเบียน Listener ได้มากกว่าหนึ่งรายการพร้อมกันสำหรับอินสแตนซ์ App Check หนึ่งรายการขึ้นไป ผู้ฟังจะโทรกลับมาที่เธรด UI ทุกครั้งที่โทเค็นปัจจุบันที่เกี่ยวข้องกับอินสแตนซ์ App Check นี้เปลี่ยนแปลง
ลายเซ็น:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอพ CheckInstance | แอพเช็ค | อินสแตนซ์บริการ App Check |
ผู้สังเกตการณ์ | ผู้สังเกตการณ์บางส่วน < ผล AppCheckToken > | อ็อบเจ็กต์ที่มีคุณสมบัติ next error และคุณสมบัติ complete next จะถูกเรียกด้วย AppCheckTokenResult ทุกครั้งที่โทเค็นเปลี่ยนแปลง error เป็นทางเลือกและจะถูกเรียกหากผู้ฟังเกิดข้อผิดพลาด (ฟังก์ชัน next ) ไม่ได้ใช้ complete เนื่องจากการสตรีมโทเค็นไม่สิ้นสุด |
ผลตอบแทน:
ฟังก์ชั่นที่จะยกเลิกการสมัครฟังนี้
onTokenChanged (appCheckInstance, onNext, onError, onCompletion)
ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น สามารถลงทะเบียน Listener ได้มากกว่าหนึ่งรายการพร้อมกันสำหรับอินสแตนซ์ App Check หนึ่งรายการขึ้นไป ผู้ฟังจะโทรกลับมาที่เธรด UI ทุกครั้งที่โทเค็นปัจจุบันที่เกี่ยวข้องกับอินสแตนซ์ App Check นี้เปลี่ยนแปลง
ลายเซ็น:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอพ CheckInstance | แอพเช็ค | อินสแตนซ์บริการ App Check |
บนถัดไป | (ผลลัพธ์โทเค็น: AppCheckTokenResult ) => เป็นโมฆะ | เมื่อโทเค็นเปลี่ยนแปลง ฟังก์ชันนี้จะถูกเรียกใช้ด้วย AppCheckTokenResult . |
บนข้อผิดพลาด | (ข้อผิดพลาด: ข้อผิดพลาด) => เป็นโมฆะ | ไม่จำเป็น. เรียกว่าหากมีข้อผิดพลาดเกิดขึ้นจาก Listener (ฟังก์ชัน onNext ) |
เมื่อเสร็จสิ้น | () => เป็นโมฆะ | ไม่ได้ใช้ในขณะนี้ เนื่องจากการสตรีมโทเค็นไม่สิ้นสุด |
ผลตอบแทน:
ฟังก์ชั่นที่จะยกเลิกการสมัครฟังนี้
setTokenAutoRefreshEnabled (appCheckInstance, isTokenAutoRefreshEnabled)
ตั้งค่าว่า App Check จะรีเฟรชโทเค็นโดยอัตโนมัติตามความจำเป็นหรือไม่
ลายเซ็น:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
พารามิเตอร์
พารามิเตอร์ | พิมพ์ | คำอธิบาย |
---|---|---|
แอพ CheckInstance | แอพเช็ค | อินสแตนซ์บริการ App Check |
isTokenAutoRefreshEnabled แล้ว | บูลีน | หากเป็นจริง SDK จะรีเฟรชโทเค็น App Check โดยอัตโนมัติตามความจำเป็น สิ่งนี้จะแทนที่ค่าใด ๆ ที่ตั้งไว้ระหว่าง initializeAppCheck() |
ผลตอบแทน:
เป็นโมฆะ
AppCheckTokenListener
Listener ที่ถูกเรียกทุกครั้งที่โทเค็น App Check เปลี่ยนแปลง
ลายเซ็น:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;