firebase-admin.extensions package

Firebase Extensions サービスで管理できます。

関数

関数 説明
getExtensions(app) デフォルト アプリまたは特定のアプリの Extensions サービスを取得します。引数なしで getExtensions() を呼び出してデフォルト アプリの Extensions サービスにアクセスするか、getExtensions(app) として呼び出して、特定のアプリに関連付けられている Extensions サービスにアクセスできます。

クラス

クラス 説明
Extensions Firebase Extensions サービス インターフェース。
ランタイム Runtime は、拡張機能インスタンスのランタイム データを変更するメソッドを提供します。

型エイリアス

タイプ エイリアス 説明
SettableProcessingState SettableProcessingState は、拡張機能インスタンスのランタイム データに設定できるすべての処理状態を表します。

getExtensions(アプリ)

デフォルト アプリまたは指定されたアプリの Extensions サービスを取得します。

デフォルト アプリの Extensions サービスにアクセスするには、引数なしで getExtensions() を呼び出すか、getExtensions(app) として呼び出して特定のアプリに関連付けられている Extensions サービスにアクセスします。

署名:

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

パラメータ

パラメータ 説明
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

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';