Firebase RemoteConfig サービス インターフェース。
署名:
export declare class RemoteConfig
プロパティ
| プロパティ | 修飾キー | タイプ | 説明 |
|---|---|---|---|
| アプリ | アプリ |
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| createTemplateFromJSON(json) | JSON 文字列から新しい Remote Config テンプレートを作成して返します。 | |
| getServerTemplate(options) | ServerTemplate をインスタンス化し、プロジェクトの最新のテンプレート バージョンを取得してキャッシュに保存します。 | |
| getTemplate() | プロジェクトの RemoteConfigTemplate の現在のアクティブなバージョンを取得します。 | |
| getTemplateAtVersion(versionNumber) | プロジェクトの RemoteConfigTemplate のリクエストされたバージョンを取得します。 | |
| initServerTemplate(options) | ServerTemplate を同期的にインスタンス化します。 | |
| listVersions(options) | 公開されている Remote Config テンプレート バージョンのリストを取得します。新しい順で並べ替えられます。最新の 300 件のバージョンのみが保存されます。アクティブでない Remote Config テンプレートに対応するすべてのバージョン（クライアントがフェッチしているテンプレートを除くすべてのバージョン）も、90 日以上経過すると削除されます。 | |
| publishTemplate(template, options) | Remote Config テンプレートを公開します。 | |
| rollback(versionNumber) | プロジェクトで公開されている Remote Config テンプレートを指定のバージョンにロールバックします。ロールバックは、以前に公開された Remote Config テンプレートを取得して強制更新を使用して再公開する操作と同等です。 | |
| validateTemplate(template) | RemoteConfigTemplate を検証します。 |
RemoteConfig.app
署名:
readonly app: App;
RemoteConfig.createTemplateFromJSON()
JSON 文字列から新しい Remote Config テンプレートを作成して返します。
署名:
createTemplateFromJSON(json: string): RemoteConfigTemplate;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| json | 文字列 | Remote Config テンプレートに入力する JSON 文字列。 |
戻り値:
新しいテンプレート インスタンス。
RemoteConfig.getServerTemplate()
ServerTemplate をインスタンス化し、プロジェクトの最新のテンプレート バージョンを取得してキャッシュに保存します。
署名:
getServerTemplate(options?: GetServerTemplateOptions): Promise<ServerTemplate>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| オプション | GetServerTemplateOptions |
戻り値:
Promise <ServerTemplate>
RemoteConfig.getTemplate()
プロジェクトの RemoteConfigTemplate の現在のアクティブなバージョンを取得します。
署名:
getTemplate(): Promise<RemoteConfigTemplate>;
戻り値:
Promise<RemoteConfigTemplate>
RemoteConfigTemplate で履行される Promise。
RemoteConfig.getTemplateAtVersion()
プロジェクトの RemoteConfigTemplate のリクエストされたバージョンを取得します。
署名:
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| versionNumber | 数値 |文字列 | 検索する Remote Config テンプレートのバージョン番号。 |
戻り値:
Promise<RemoteConfigTemplate>
RemoteConfigTemplate で履行される Promise。
RemoteConfig.initServerTemplate()
ServerTemplate を同期的にインスタンス化します。
署名:
initServerTemplate(options?: InitServerTemplateOptions): ServerTemplate;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| オプション | InitServerTemplateOptions |
戻り値:
RemoteConfig.listVersions()
公開されている Remote Config テンプレート バージョンのリストを取得します。新しい順で並べ替えられます。最新の 300 件のバージョンのみが保存されます。アクティブでない Remote Config テンプレートに対応するすべてのバージョン（クライアントがフェッチしているテンプレートを除くすべてのバージョン）も、90 日以上経過すると削除されます。
署名:
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| オプション | ListVersionsOptions | バージョンのリストを取得するためのオプションのオプション オブジェクト。 |
戻り値:
Promise <ListVersionsResult>
ListVersionsResult で履行される Promise。
RemoteConfig.publishTemplate()
Remote Config テンプレートを公開します。
署名:
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
}): Promise<RemoteConfigTemplate>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| テンプレート | RemoteConfigTemplate | 公開する Remote Config テンプレート。 |
| オプション | { force: boolean;} | Remote Config テンプレートを公開する際のオプション オブジェクト: - force: これを true に設定すると、Remote Config テンプレートが強制的に更新され、ETag が回避されます。このアプローチは、複数のクライアントが Remote Config テンプレートを更新する場合に Remote Config テンプレートの更新が失われるリスクがあるため、おすすめしません。ETag の使用と強制更新をご覧ください。 |
戻り値:
Promise<RemoteConfigTemplate>
公開された RemoteConfigTemplate で履行される Promise。
RemoteConfig.rollback()
プロジェクトで公開されている Remote Config テンプレートを指定のバージョンにロールバックします。ロールバックは、以前に公開された Remote Config テンプレートを取得して強制更新を使用して再公開する操作と同等です。
署名:
rollback(versionNumber: number | string): Promise<RemoteConfigTemplate>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| versionNumber | 数値 |文字列 | ロールバックする Remote Config テンプレートのバージョン番号。指定するバージョン番号は、現在のバージョン番号よりも小さくする必要があります。また、未更新のために削除されていないことが必要です。最新の 300 件のバージョンのみが保存されます。アクティブでない Remote Config テンプレートに対応するすべてのバージョン（クライアントがフェッチしているテンプレートを除くすべて）は、作成後 90 日が経過すると削除されます。 |
戻り値:
Promise<RemoteConfigTemplate>
公開された RemoteConfigTemplate で履行される Promise。
RemoteConfig.validateTemplate()
RemoteConfigTemplate を検証します。
署名:
validateTemplate(template: RemoteConfigTemplate): Promise<RemoteConfigTemplate>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| テンプレート | RemoteConfigTemplate | 検証する Remote Config テンプレート。 |
戻り値:
Promise<RemoteConfigTemplate>
検証された RemoteConfigTemplate で履行される Promise。