firebase-admin.extensions package

Firebase Extensions

ฟังก์ชัน

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

ชั้นเรียน

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

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

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

getextension(แอป)

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

สามารถเรียก 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';