remote-config package

Firebase Remote Config Web SDK。この SDK は Node.js 環境では動作しません。

関数

関数 説明
function(app, ...)
getRemoteConfig(app)
function(remoteConfig, ...)
activate(remoteConfig) 最後にフェッチされた構成をゲッターが使用できるようにします。
ensureInitialized(remoteConfig) 最後に有効化された構成をゲッターが利用できるようにします。
fetchAndActivate(remoteConfig) 便宜上、フェッチと有効化のオペレーションを実行します。
fetchConfig(remoteConfig) Remote Config サービスから構成を取得してキャッシュに保存します。
getAll(remoteConfig) すべての構成を取得します。
getBoolean(remoteConfig, key) 指定されたキーの値をブール値として取得します。remoteConfig.getValue(key).asBoolean() を呼び出すためのコンビニエンス メソッドです。
getNumber(remoteConfig, key) 指定されたキーの値を数値として取得します。remoteConfig.getValue(key).asNumber() を呼び出すためのコンビニエンス メソッドです。
getString(remoteConfig, key) 指定されたキーの値を文字列として取得します。remoteConfig.getValue(key).asString() を呼び出すためのコンビニエンス メソッド。
getValue(remoteConfig, key) 指定されたキーの値を取得します。
setLogLevel(remoteConfig, logLevel) 使用するログレベルを定義します。
function（）
isSupported() この方法では、次の 2 つのチェックを行います。1.IndexedDB がブラウザ環境に存在するかどうかを確認します。2. 現在のブラウザ コンテキストで IndexedDB の open() 呼び出しが許可されているかどうかを確認します。

インターフェース

インターフェース 説明
RemoteConfig Firebase Remote Config サービス インターフェース。
RemoteConfigSettings Remote Config SDK の構成オプションを定義します。
値 メタデータとタイプセーフなゲッターで値をラップします。

型エイリアス

型エイリアス 説明
FetchStatus Firebase Remote Config サーバーから構成をフェッチしようとした最後の結果の概要を示します。
  • 「まだ取得していません」RemoteConfig インスタンスがまだ構成のフェッチを試行していないか、SDK の初期化が完了していないことを示します。
  • "success"最後の試行が成功したことを示します。
  • "失敗"最後の試行が失敗したことを示します。
  • 「throttle」最後の試行がレート制限されたことを示します。
ログレベル Remote Config ロギングのレベルを定義します。
ValueSource 値のソースを示します。
  • 「静的」値が静的定数によって定義されたことを示します。
  • 「デフォルト」値はデフォルトの構成で定義されていることを示します。
  • 「リモート」値はフェッチされた構成によって定義されたことを示します。

関数（アプリ、...）

getRemoteConfig（アプリ）

署名:

export declare function getRemoteConfig(app?: FirebaseApp): RemoteConfig;

パラメータ

パラメータ 型 説明
アプリ FirebaseApp FirebaseApp インスタンス。

戻り値:

RemoteConfig

RemoteConfig インスタンス。

関数（remoteConfig, ...）

活性化（remoteConfig）

最後にフェッチされた構成をゲッターが使用できるようにします。

署名:

export declare function activate(remoteConfig: RemoteConfig): Promise<boolean>;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。

戻り値:

Promise&lt;boolean&gt;

Promise。現在の呼び出しによって取得された構成がアクティブになった場合、true に解決されます。フェッチした構成がすでにアクティブになっている場合、Promise は false に解決されます。

checkInitialized（remoteConfig）

最後に有効化された構成をゲッターが利用できるようにします。

署名:

export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise<void>;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。

戻り値:

約束 <void>

最後に有効化された構成がゲッターで利用可能になったときに解決される Promise。

fetchAndActivate(remoteConfig)

便宜上、フェッチと有効化のオペレーションを実行します。

署名:

export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。

戻り値:

Promise&lt;boolean&gt;

Promise。現在の呼び出しによって取得された構成がアクティブになった場合、true に解決されます。フェッチした構成がすでにアクティブになっている場合、Promise は false に解決されます。

fetchConfig（remoteConfig）

Remote Config サービスから構成を取得してキャッシュに保存します。

署名:

export declare function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。

戻り値:

約束 <void>

getAll（リモート構成）

すべての構成を取得します。

署名:

export declare function getAll(remoteConfig: RemoteConfig): Record<string, Value>;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。

戻り値:

レコード<文字列, 値>

すべての構成。

getBoolean(remoteConfig, key)

指定されたキーの値をブール値として取得します。

remoteConfig.getValue(key).asBoolean() を呼び出すためのコンビニエンス メソッド。

署名:

export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。
key 文字列 パラメータの名前。

戻り値:

ブール値

指定されたキーの値（ブール値）。

getNumber(remoteConfig, key)

指定されたキーの値を数値として取得します。

remoteConfig.getValue(key).asNumber() を呼び出すためのコンビニエンス メソッド。

署名:

export declare function getNumber(remoteConfig: RemoteConfig, key: string): number;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。
key 文字列 パラメータの名前。

戻り値:

数値

指定されたキーの値（数値）。

getString(remoteConfig, key)

指定されたキーの値を文字列として取得します。remoteConfig.getValue(key).asString() を呼び出すためのコンビニエンス メソッド。

署名:

export declare function getString(remoteConfig: RemoteConfig, key: string): string;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。
key 文字列 パラメータの名前。

戻り値:

文字列

指定されたキーの値（文字列）。

getValue(remoteConfig, key)

指定されたキーの値を取得します。

署名:

export declare function getValue(remoteConfig: RemoteConfig, key: string): Value;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。
key 文字列 パラメータの名前。

戻り値:

値

指定されたキーの値。

setLogLevel(remoteConfig, logLevel)

使用するログレベルを定義します。

署名:

export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

パラメータ

パラメータ 型 説明
RemoteConfig RemoteConfig RemoteConfig インスタンス。
logLevel RemoteConfigLogLevel 設定するログレベル。

戻り値:

void

関数

isSupported()

この方法では、次の 2 つのチェックを行います。

  1. IndexedDB がブラウザ環境に存在するかどうかを確認します。2. 現在のブラウザ コンテキストで IndexedDB の open() 呼び出しが許可されているかどうかを確認します。

署名:

export declare function isSupported(): Promise<boolean>;

戻り値:

Promise&lt;boolean&gt;

Promise。この環境で RemoteConfig インスタンスを初期化できる場合は true、初期化できない場合は false に解決されます。

FetchStatus

Firebase Remote Config サーバーから構成をフェッチしようとした最後の結果の概要を示します。

  • 「まだ取得していません」[RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) インスタンスがまだ構成のフェッチを試行していないか、SDK の初期化が完了していないことを示します。
  • "success"最後の試行が成功したことを示します。
  • "失敗"最後の試行が失敗したことを示します。
  • 「throttle」最後の試行がレート制限されたことを示します。

署名:

export declare type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle';

LogLevel

Remote Config ロギングのレベルを定義します。

署名:

export declare type LogLevel = 'debug' | 'error' | 'silent';

ValueSource

値のソースを示します。

  • 「静的」値が静的定数によって定義されたことを示します。
  • 「デフォルト」値はデフォルトの構成で定義されていることを示します。
  • 「リモート」値はフェッチされた構成によって定義されたことを示します。

署名:

export declare type ValueSource = 'static' | 'default' | 'remote';