Firebase Extensions サービス。
関数
| 関数 | 説明 |
|---|---|
| getExtensions（アプリ） | デフォルト アプリまたは特定のアプリの Extensions サービスを取得します。getExtensions() は、引数なしでデフォルト アプリの Extensions サービスにアクセスするか、getExtensions(app) として呼び出して、特定のアプリに関連付けられた Extensions サービスにアクセスできます。 |
クラス
| クラス | 説明 |
|---|---|
| Extensions | Firebase Extensions サービス インターフェース。 |
| ランタイム | ランタイムは、拡張機能インスタンスのランタイム データを変更するメソッドを提供します。 |
型エイリアス
| 型エイリアス | 説明 |
|---|---|
| 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
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';