remote-config package

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

機能

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

インターフェース

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

タイプエイリアス

タイプエイリアス説明
フェッチステータスFirebase Remote Config サーバーから構成を取得する最後の試行の結果を要約します。
  • 「no-fetch-yet」は、 RemoteConfigインスタンスがまだ構成の取得を試行していないか、SDK の初期化が不完全であることを示します。
  • 「成功」は、最後の試行が成功したことを示します。
  • 「失敗」は、最後の試行が失敗したことを示します。
  • 「throttle」は、最後の試行がレート制限されたことを示します。
ログレベルRemote Config のログのレベルを定義します。
値のソース値のソースを示します。
  • 「static」は、値が静的定数によって定義されたことを示します。
  • 「default」は、値がデフォルト設定で定義されたことを示します。
  • 「remote」は、値がフェッチされた構成によって定義されたことを示します。

関数(アプリ、...)

getRemoteConfig(アプリ)

サイン:

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

パラメーター

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

戻り値:

リモートコンフィグ

RemoteConfigインスタンス。

関数(remoteConfig, ...)

アクティブ化(remoteConfig)

最後に取得した構成をゲッターが利用できるようにします。

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。

戻り値:

Promise<ブール値>

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

ensureInitialized(remoteConfig)

最後にアクティブ化された構成がゲッターで使用できるようにします。

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。

戻り値:

約束<無効>

最後にアクティブ化された構成がゲッターに利用可能になったときに解決されるPromise

fetchAndActivate(remoteConfig)

便宜上、フェッチ操作とアクティブ化操作を実行します。

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。

戻り値:

Promise<ブール値>

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

fetchConfig(remoteConfig)

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

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。

戻り値:

約束<無効>

getAll(remoteConfig)

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

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。

戻り値:

レコード<文字列、>

すべての構成。

getBoolean(remoteConfig, キー)

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

remoteConfig.getValue(key).asBoolean()を呼び出すための便利なメソッド。

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。
パラメータの名前。

戻り値:

ブール値

ブール値としての指定されたキーの値。

getNumber(remoteConfig, キー)

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

remoteConfig.getValue(key).asNumber()を呼び出すための便利なメソッド。

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。
パラメータの名前。

戻り値:

番号

指定されたキーの数値としての値。

getString(remoteConfig, キー)

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

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。
パラメータの名前。

戻り値:

文字列としての指定されたキーの値。

getValue(remoteConfig, キー)

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

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。
パラメータの名前。

戻り値:

価値

指定されたキーの値。

setLogLevel(remoteConfig, logLevel)

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

サイン:

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

パラメーター

パラメータタイプ説明
リモート構成リモートコンフィグRemoteConfigインスタンス。
ログレベルRemoteConfigLogLevel設定するログレベル。

戻り値:

空所

関数()

isSupported()

この方法では、次の 2 つの異なるチェックが行われます。

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

サイン:

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

戻り値:

Promise<ブール値>

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

フェッチステータス

Firebase Remote Config サーバーから構成を取得する最後の試行の結果を要約します。

  • 「no-fetch-yet」は、[RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) インスタンスがまだ構成の取得を試みていないか、SDK の初期化が不完全であることを示します。
  • 「成功」は、最後の試行が成功したことを示します。
  • 「失敗」は、最後の試行が失敗したことを示します。
  • 「throttle」は、最後の試行がレート制限されたことを示します。

サイン:

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

ログレベル

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

サイン:

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

値のソース

値のソースを示します。

  • 「static」は、値が静的定数によって定義されたことを示します。
  • 「default」は、値がデフォルト設定で定義されたことを示します。
  • 「remote」は、値がフェッチされた構成によって定義されたことを示します。

サイン:

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