remoteConfig namespace

関数

関数 説明
onConfigUpdated(handler) Remote Config でデータが更新されたときにトリガーされるイベント ハンドラ。
onConfigUpdated(opts, handler) Remote Config でデータが更新されたときにトリガーされるイベント ハンドラ。

インターフェース

インターフェース 説明
ConfigUpdateData Firebase Remote Config 更新イベント内のデータ。
ConfigUser Remote Config テンプレートを作成したユーザー/サービス アカウントに関連付けられているすべてのフィールド。

型エイリアス

型エイリアス 説明
ConfigUpdateOrigin Remote Config テンプレートのバージョンに関連付けられた更新の種類。
ConfigUpdateType Remote Config の更新アクションの実行元。

RemoteConfig.onConfigUpdated()

Remote Config でデータが更新されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onConfigUpdated(handler: (event: CloudEvent<ConfigUpdateData>) => any | Promise<any>): CloudFunction<CloudEvent<ConfigUpdateData>>;

パラメータ

パラメータ 型 説明
handler （イベント: CloudEvent<ConfigUpdateData>）=>任意 |<任意> を約束する Remote Config の更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<CloudEvent<ConfigUpdateData>>

エクスポートしてデプロイできる関数。

RemoteConfig.onConfigUpdated()

Remote Config でデータが更新されたときにトリガーされるイベント ハンドラ。

署名:

export declare function onConfigUpdated(opts: EventHandlerOptions, handler: (event: CloudEvent<ConfigUpdateData>) => any | Promise<any>): CloudFunction<CloudEvent<ConfigUpdateData>>;

パラメータ

パラメータ 型 説明
最適化 EventHandlerOptions 個々のイベント処理関数で設定できるオプション。
handler （イベント: CloudEvent<ConfigUpdateData>）=>任意 |<任意> を約束する Remote Config の更新が発生するたびに実行されるイベント ハンドラ。

戻り値:

CloudFunction<CloudEvent<ConfigUpdateData>>

エクスポートしてデプロイできる関数。

RemoteConfig.ConfigUpdateOrigin

Remote Config テンプレートのバージョンに関連付けられた更新の種類。

署名:

export type ConfigUpdateOrigin = 
/** Catch-all for unrecognized values. */
"REMOTE_CONFIG_UPDATE_ORIGIN_UNSPECIFIED"
/** The update came from the Firebase UI. */
 | "CONSOLE"
/** The update came from the Remote Config REST API. */
 | "REST_API"
/** The update came from the Firebase Admin Node SDK. */
 | "ADMIN_SDK_NODE";

RemoteConfig.ConfigUpdateType

Remote Config の更新アクションの実行元。

署名:

export type ConfigUpdateType = 
/** Catch-all for unrecognized enum values */
"REMOTE_CONFIG_UPDATE_TYPE_UNSPECIFIED"
/** A regular incremental update */
 | "INCREMENTAL_UPDATE"
/** A forced update. The ETag was specified as "*" in an UpdateRemoteConfigRequest request or the "Force Update" button was pressed on the console */
 | "FORCED_UPDATE"
/** A rollback to a previous Remote Config template */
 | "ROLLBACK";