firebase-admin.extensions package

บริการ Firebase Extensions

ฟังก์ชัน

ฟังก์ชัน คำอธิบาย
getextensions(แอป) รับบริการส่วนขยายสำหรับแอปเริ่มต้นหรือแอปที่กำหนด getExtensions() สามารถเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Extensions ของแอปเริ่มต้น หรือโดยใช้ getExtensions(app) เพื่อเข้าถึงบริการของ Extensions ที่เชื่อมโยงกับแอปใดแอปหนึ่ง

คลาส

ชั้น คำอธิบาย
ส่วนขยาย อินเทอร์เฟซบริการ Extensions ของ Firebase
รันไทม์ รันไทม์ให้วิธีการแก้ไขข้อมูลรันไทม์ของอินสแตนซ์ส่วนขยาย

ประเภทชื่อแทน

ประเภทชื่อแทน คำอธิบาย
SettableProcessingState SettableProcessingState แสดงถึงสถานะการประมวลผลทั้งหมดที่ตั้งค่าในข้อมูลรันไทม์ของอินสแตนซ์ส่วนขยายได้

getextensions(แอป)

รับบริการส่วนขยายสำหรับแอปเริ่มต้นหรือแอปที่กำหนด

สามารถเรียก getExtensions() โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Extensions ของแอปเริ่มต้น หรือเรียกใช้เป็น getExtensions(app) เพื่อเข้าถึงบริการของ Extensions ที่เชื่อมโยงกับแอปใดแอปหนึ่งโดยเฉพาะ

ลายเซ็น:

export declare function getExtensions(app?: App): Extensions;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
แอป แอป แอปที่ไม่บังคับสำหรับส่งคืนบริการของ Extensions หากไม่ระบุ ระบบจะส่งคืนบริการ Extensions เริ่มต้น

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

ส่วนขยาย

บริการ Extensions เริ่มต้นหากไม่มีการให้แอป หรือบริการ Extensions ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่าง 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

ตัวอย่าง 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

สถานะการประมวลผลข้อมูลที่ตั้งค่าได้

SettableProcessingState แสดงถึงสถานะการประมวลผลทั้งหมดที่ตั้งค่าในข้อมูลรันไทม์ของอินสแตนซ์ส่วนขยายได้

คุณตั้งค่าสถานะต่อไปนี้ได้

  • NONE: ไม่มีการทำงานเหตุการณ์ในวงจรที่เกี่ยวข้องใดๆ ตั้งค่านี้เพื่อล้างสถานะเก่า

  • PROCESSING_COMPLETE: งานเหตุการณ์ตลอดอายุการใช้งานเสร็จสมบูรณ์โดยไม่มีข้อผิดพลาด

  • PROCESSING_WARNING: งานของเหตุการณ์ในวงจรประสบความสำเร็จเพียงบางส่วน หรือมีบางอย่างเกิดขึ้นที่ผู้ใช้ควรได้รับการเตือน

  • PROCESSING_FAILED: การทำงานสำหรับเหตุการณ์ในวงจรล้มเหลวอย่างสิ้นเชิง แต่อินสแตนซ์จะยังคงทำงานได้อย่างถูกต้องนับจากนี้ไป

หากอินสแตนซ์ของส่วนขยายอยู่ในสถานะเสียเนื่องจากมีข้อผิดพลาด ให้เรียก Runtime.setFatalError() แทน

สถานะ "กำลังประมวลผล" จะได้รับการตั้งค่าโดยอัตโนมัติเมื่อตัวแฮนเดิลเหตุการณ์ตลอดอายุการใช้งานเริ่มทำงาน คุณไม่สามารถตั้งค่าอย่างชัดเจนได้ หากต้องการรายงานสถานะต่อเนื่องของฟังก์ชันของส่วนขยาย ให้ใช้ console.log หรือ SDK ตัวบันทึก Cloud Functions

ลายเซ็น:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';