firebase-admin.extensions package

Firebase Extensions 服務。

函式

函式 說明
getExtensions(應用程式) 取得預設應用程式或特定應用程式的擴充功能服務。getExtensions() 可以在沒有引數的情況下呼叫 getExtensions(),藉此存取預設應用程式的 Extensions 服務,也可以當做 getExtensions(app) 來存取與特定應用程式相關聯的 Extensions 服務。

等級

類別 說明
擴充功能 Firebase Extensions 服務介面。
執行階段 執行階段提供修改擴充功能執行個體的執行階段資料的方法。

類型別名

類型別名 說明
SettableProcessingState SettableProcessingState 代表可對擴充功能執行個體執行階段資料設定的所有處理狀態。

getExtensions(應用程式)

取得預設應用程式或特定應用程式的擴充功能服務。

呼叫 getExtensions() 時無需引數,即可存取預設應用程式的 Extensions 服務,或做為 getExtensions(app) 存取與特定應用程式相關聯的 Extensions 服務。

簽名:

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

參數

參數 類型 說明
app 應用程式 用於傳回 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

SettableProcessingState 代表可對擴充功能執行個體執行階段資料設定的所有處理狀態。

您可以設定下列狀態:

  • NONE:尚未執行任何相關的生命週期事件工作。完成這項設定即可清除舊狀態。

  • PROCESSING_COMPLETE:生命週期事件已完成,沒有錯誤。

  • PROCESSING_WARNING:生命週期事件已完成部分作業,或是系統應警告使用者的問題。

  • PROCESSING_FAILED:生命週期事件完全失敗,但執行個體日後仍會正常運作。

如果擴充功能執行個體因錯誤而處於損毀狀態,請改為呼叫 Runtime.setFatalError()

生命週期事件處理常式啟動時,會自動設定「處理」狀態,無法明確設定。如要回報擴充功能函式的持續狀態,請使用 console.log 或 Cloud Functions 記錄器 SDK。

簽名:

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