app-check package

SDK เว็บของ Firebase App Check

Firebase App Check จะไม่ทำงานในสภาพแวดล้อม Node.js ที่ใช้ ReCaptchaV3Provider หรือ ReCaptchaEnterpriseProvider แต่คุณสามารถใช้ใน Node.js ได้หากคุณใช้ CustomProvider และเขียนเมธอดเอกสารรับรองของคุณเอง

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
ฟังก์ชัน(แอป, ...)
initializeAppCheck(แอป ตัวเลือก)	เปิดใช้งาน App Check สำหรับแอปที่กำหนด โทรได้ 1 ครั้งต่อแอปเท่านั้น
function(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)	ขอโทเค็น Firebase App Check ควรใช้เมธอดนี้เมื่อคุณต้องการให้คำขอเข้าถึงแบ็กเอนด์ที่ไม่ใช่ Firebase เท่านั้นส่งคืนโทเค็นที่มีการใช้งานแบบจำกัดซึ่งมีไว้สำหรับใช้กับปลายทางแบ็กเอนด์ที่ไม่ใช่ Firebase ซึ่งได้รับการป้องกันด้วย การป้องกันการเล่นซ้ำ เมธอดนี้ไม่มีผลต่อลักษณะการสร้างโทเค็นของเมธอด #getAppCheckToken()
getToken(appCheckInstance, forceRefresh)	รับโทเค็น App Check ปัจจุบัน หาก forceRefresh เป็นเท็จ ฟังก์ชันนี้จะตรวจสอบโทเค็นที่ถูกต้องในหน่วยความจำก่อน จากนั้นจึงตรวจสอบความต่อเนื่องในเครื่อง (IndexedDB) หากไม่พบหรือ forceRefresh เป็นจริง ระบบจะส่งคำขอไปยังปลายทาง App Check เพื่อรับโทเค็นใหม่ คำขอนั้นแนบไปกับคำขอล่าสุดที่กำลังดำเนินการอยู่ หากมี
onTokenChanged(appCheckInstance, ผู้สังเกตการณ์)	ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น อาจมี Listener ที่ลงทะเบียนพร้อมกันมากกว่า 1 รายการสำหรับอินสแตนซ์ App Check อย่างน้อย 1 รายการ Listener จะติดต่อกลับในชุดข้อความ UI ทุกครั้งที่โทเค็นปัจจุบันที่เชื่อมโยงกับอินสแตนซ์ App Check นี้มีการเปลี่ยนแปลง
onTokenChanged(appCheckInstance, onNext, onError, onถูกลบ)	ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น อาจมี Listener ที่ลงทะเบียนพร้อมกันมากกว่า 1 รายการสำหรับอินสแตนซ์ App Check อย่างน้อย 1 รายการ Listener จะติดต่อกลับในชุดข้อความ UI ทุกครั้งที่โทเค็นปัจจุบันที่เชื่อมโยงกับอินสแตนซ์ App Check นี้มีการเปลี่ยนแปลง
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)	ตั้งค่าว่าจะให้ App Check รีเฟรชโทเค็นโดยอัตโนมัติตามความจำเป็นหรือไม่

ชั้นเรียน

ชั้น	คำอธิบาย
CustomProvider	คลาสของผู้ให้บริการที่กำหนดเอง
ReCaptchaEnterpriseProvider	ผู้ให้บริการ App Check ที่รับโทเค็น reCAPTCHA Enterprise และแลกเปลี่ยนเป็นโทเค็น App Check
ReCaptchaV3Provider	ผู้ให้บริการ App Check ที่รับโทเค็น reCAPTCHA V3 และแลกเปลี่ยนเป็นโทเค็น App Check

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
AppCheck	อินเทอร์เฟซบริการ Firebase App Check
AppCheckOptions	ตัวเลือกสำหรับการเริ่มต้น App Check
AppCheckToken	โทเค็นที่ส่งคืนจากผู้ให้บริการ App Check
AppCheckTokenผลลัพธ์	getToken() แสดงผลลัพธ์
CustomProviderOptions	ตัวเลือกเมื่อสร้าง CustomProvider

พิมพ์ชื่อแทน

พิมพ์ชื่อแทน	คำอธิบาย
AppCheckTokenListener	Listener ที่ถูกเรียกเมื่อโทเค็น App Check มีการเปลี่ยนแปลง

ฟังก์ชัน(แอป, ...)

defaultizeAppCheck(แอป ตัวเลือก)

เปิดใช้งาน App Check สำหรับแอปที่กำหนด โทรได้ 1 ครั้งต่อแอปเท่านั้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	FirebaseApp ไม่ได้กำหนด	FirebaseApp เพื่อเปิดใช้งาน App Check
ตัวเลือก	AppCheckOptions	ตัวเลือกการเริ่มต้น App Check

การคืนสินค้า:

AppCheck

ฟังก์ชัน(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

ขอโทเค็น Firebase App Check ควรใช้เมธอดนี้เฉพาะเมื่อคุณต้องการให้สิทธิ์คำขอไปยังแบ็กเอนด์ที่ไม่ใช่ Firebase เท่านั้น

แสดงผลโทเค็นที่มีการใช้งานแบบจำกัดซึ่งมีไว้สำหรับใช้กับปลายทางแบ็กเอนด์ที่ไม่ใช่ Firebase ที่มีการป้องกันด้วย การป้องกันการเล่นซ้ำ เมธอดนี้ไม่มีผลต่อลักษณะการสร้างโทเค็นของเมธอด #getAppCheckToken()

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
AppCheckInstance	AppCheck	อินสแตนซ์บริการ App Check

การคืนสินค้า:

สัญญา<AppCheckTokenผลลัพธ์>

โทเค็นการใช้งานแบบจำกัด

getToken(appCheckInstance, forceRefresh)

รับโทเค็น App Check ปัจจุบัน หาก forceRefresh เป็นเท็จ ฟังก์ชันนี้จะตรวจสอบโทเค็นที่ถูกต้องในหน่วยความจำก่อน จากนั้นจึงตรวจสอบความต่อเนื่องในเครื่อง (IndexedDB) หากไม่พบหรือ forceRefresh เป็นจริง ระบบจะส่งคำขอไปยังปลายทาง App Check เพื่อรับโทเค็นใหม่ คำขอนั้นแนบไปกับคำขอล่าสุดที่กำลังดำเนินการอยู่ หากมี

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
AppCheckInstance	AppCheck	อินสแตนซ์บริการ App Check
ForceRefresh	boolean	หาก "จริง" จะพยายามดึงข้อมูลโทเค็นใหม่เสมอ หากเป็น "เท็จ" จะใช้โทเค็นที่แคชไว้ หากพบในพื้นที่เก็บข้อมูล

การคืนสินค้า:

สัญญา<AppCheckTokenผลลัพธ์>

onTokenChanged(appCheckInstance, ผู้สังเกตการณ์)

ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น อาจมี Listener ที่ลงทะเบียนพร้อมกันมากกว่า 1 รายการสำหรับอินสแตนซ์ App Check อย่างน้อย 1 รายการ Listener จะติดต่อกลับในชุดข้อความ UI ทุกครั้งที่โทเค็นปัจจุบันที่เชื่อมโยงกับอินสแตนซ์ App Check นี้มีการเปลี่ยนแปลง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
AppCheckInstance	AppCheck	อินสแตนซ์บริการ App Check
ผู้สังเกตการณ์	partObserver<AppCheckTokenผลลัพธ์>	ออบเจ็กต์ที่มีพร็อพเพอร์ตี้ next, error และ complete ระบบจะเรียก next ด้วย AppCheckTokenResult ทุกครั้งที่โทเค็นมีการเปลี่ยนแปลง error เป็นตัวเลือกที่ไม่บังคับและจะเรียกใช้หาก Listener แสดงข้อผิดพลาด (ฟังก์ชัน next) ไม่ได้ใช้ complete เนื่องจากสตรีมโทเค็นไม่มีที่สิ้นสุด

การคืนสินค้า:

ยกเลิกการสมัคร

ฟังก์ชันที่ยกเลิกการสมัครรับข่าวสารนี้

onTokenChanged(appCheckInstance, onNext, onError, onComplete)

ลงทะเบียน Listener เพื่อเปลี่ยนแปลงสถานะโทเค็น อาจมี Listener ที่ลงทะเบียนพร้อมกันมากกว่า 1 รายการสำหรับอินสแตนซ์ App Check อย่างน้อย 1 รายการ Listener จะติดต่อกลับในชุดข้อความ UI ทุกครั้งที่โทเค็นปัจจุบันที่เชื่อมโยงกับอินสแตนซ์ App Check นี้มีการเปลี่ยนแปลง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
AppCheckInstance	AppCheck	อินสแตนซ์บริการ App Check
ถัดไป	(tokenผลลัพธ์: AppCheckTokenผลลัพธ์) => เป็นโมฆะ	เมื่อโทเค็นมีการเปลี่ยนแปลง ระบบจะเรียกใช้ฟังก์ชันนี้ด้วย AppCheckTokenผลลัพธ์
onError	(ข้อผิดพลาด: ข้อผิดพลาด) => เป็นโมฆะ	ไม่บังคับ มีการเรียกหาก Listener มีข้อผิดพลาด (ฟังก์ชัน onNext)
เสร็จสมบูรณ์	() => เป็นโมฆะ	ขณะนี้ยังไม่มีการใช้งาน เนื่องจากสตรีมโทเค็นไม่มีที่สิ้นสุด

การคืนสินค้า:

ยกเลิกการสมัคร

ฟังก์ชันที่ยกเลิกการสมัครรับข่าวสารนี้

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

ตั้งค่าว่าจะให้ App Check รีเฟรชโทเค็นโดยอัตโนมัติตามความจำเป็นหรือไม่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
AppCheckInstance	AppCheck	อินสแตนซ์บริการ App Check
isTokenAutoRefreshEnabled	boolean	หากเป็น "จริง" SDK จะรีเฟรชโทเค็น App Check โดยอัตโนมัติตามความจำเป็น ซึ่งจะลบล้างค่าใดๆ ที่ตั้งไว้ในช่วง initializeAppCheck()

การคืนสินค้า:

เป็นโมฆะ

AppCheckTokenListener

Listener ที่ถูกเรียกเมื่อโทเค็น App Check มีการเปลี่ยนแปลง

ลายเซ็น:

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