__CAPGO_KEEP_3__

このプラグインのインストール手順とフルマークダウンガイドを含む設定プロンプトをコピーしてください。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-remote-config`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/firebase-remote-config/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

bun add @capgo/capacitor-firebase-remote-config
bunx cap sync

インポート

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

APIの概要

`activate`

取得した最後の設定をゲッターに利用できるようにします。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.activate();

`fetchAndActivate`

フェッチとアクティベートのオペレーションを実行します。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.fetchAndActivate();

`fetchConfig`

リモート設定サービスから設定をフェッチしキャッシュします。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.fetchConfig();

`getBoolean`

指定されたキーに対して値を真偽値として取得します。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.getBoolean({} as GetBooleanOptions);

`getNumber`

指定されたキーに対応する数値を取得します。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.getNumber({} as GetNumberOptions);

`getString`

指定されたキーに対応する文字列を取得します。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.getString({} as GetStringOptions);

`getInfo`

getInfo

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.getInfo();

`setMinimumFetchInterval`

getInfo

setMinimumFetchInterval

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.setMinimumFetchInterval({} as SetMinimumFetchIntervalOptions);

`setSettings`

リモート設定を設定します。

Androidでは、設定値はSharedPreferencesに保存されます。

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.setSettings({} as SetSettingsOptions);

`addConfigUpdateListener`

設定更新イベントのリスナーを追加します。

AndroidとiOSのみ対応

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.addConfigUpdateListener({} as AddConfigUpdateListenerOptionsCallback);

`removeConfigUpdateListener`

設定更新イベントのリスナーを削除します。

AndroidとiOSのみ対応

import { FirebaseRemoteConfig } from '@capgo/capacitor-firebase-remote-config';

await FirebaseRemoteConfig.removeConfigUpdateListener({} as RemoveConfigUpdateListenerOptions);

型式リファレンス

`FetchConfigOptions`

export interface FetchConfigOptions {
  /**
   * Define the maximum age in seconds of an entry in the config cache before it is considered stale.
   * During development, it's recommended to set a relatively low minimum fetch interval.
   *
   * Only available for Android and iOS.
   *
   * @since 1.3.0
   * @default 43200
   * @see https://firebase.google.com/docs/reference/js/firebase.remoteconfig.RemoteConfigSettings#minimumfetchintervalmillis
   */
  minimumFetchIntervalInSeconds?: number;
}

`GetBooleanOptions`

export type GetBooleanOptions = GetOptions;

`GetBooleanResult`

export interface GetBooleanResult {
  /**
   * The value for the given key as a boolean.
   *
   * @since 1.3.0
   */
  value: boolean;
  /**
   * Indicates at which source this value came from.
   *
   * Only available for Android and iOS.
   *
   * @since 1.3.0
   */
  source?: GetValueSource;
}

`GetNumberOptions`

export type GetNumberOptions = GetOptions;

`GetNumberResult`

export interface GetNumberResult {
  /**
   * The value for the given key as a number.
   *
   * @since 1.3.0
   */
  value: number;
  /**
   * Indicates at which source this value came from.
   *
   * Only available for Android and iOS.
   *
   * @since 1.3.0
   */
  source?: GetValueSource;
}

`GetStringOptions`

export type GetStringOptions = GetOptions;

`GetStringResult`

export interface GetStringResult {
  /**
   * The value for the given key as a string.
   *
   * @since 1.3.0
   */
  value: string;
  /**
   * Indicates at which source this value came from.
   *
   * Only available for Android and iOS.
   *
   * @since 1.3.0
   */
  source?: GetValueSource;
}

`GetInfoResult`

export interface GetInfoResult {
  /**
   * The Unix timestamp in milliseconds of the last successful fetch, or -1 if no fetch has occurred or initialization is incomplete.
   * @since 7.5.0
   * @example 1762864760
   */
  lastFetchTime: number;
  /**
   * The status of the last fetch attempt.
   * @since 7.5.0
   * @example 1
   */
  lastFetchStatus: LastFetchStatus;
}

`SetMinimumFetchIntervalOptions`

export interface SetMinimumFetchIntervalOptions {
  /**
   * Define the maximum age in seconds of an entry in the config cache before it is considered stale.
   * During development, it's recommended to set a relatively low minimum fetch interval.
   *
   * @since 1.3.0
   * @default 43200
   * @see https://firebase.google.com/docs/reference/js/remote-config.remoteconfigsettings#remoteconfigsettingsminimumfetchintervalmillis
   */
  minimumFetchIntervalInSeconds: number;
}

`SetSettingsOptions`

export interface SetSettingsOptions {
  /**
   * Defines the maximum amount of milliseconds to wait for a response when fetching configuration from the Remote Config server.
   *
   * @since 6.2.0
   * @default 60
   * @see https://firebase.google.com/docs/reference/js/remote-config.remoteconfigsettings#remoteconfigsettingsfetchtimeoutmillis
   */
  fetchTimeoutInSeconds?: number;
  /**
   * Define the maximum age in seconds of an entry in the config cache before it is considered stale.
   * During development, it's recommended to set a relatively low minimum fetch interval.
   *
   * @since 6.2.0
   * @default 43200
   * @see https://firebase.google.com/docs/reference/js/remote-config.remoteconfigsettings#remoteconfigsettingsminimumfetchintervalmillis
   */
  minimumFetchIntervalInSeconds?: number;
}

`AddConfigUpdateListenerOptionsCallback`

export type AddConfigUpdateListenerOptionsCallback = (
  event: AddConfigUpdateListenerOptionsCallbackEvent | null,
  error: any,
) => void;

`CallbackId`

export type CallbackId = string;

真実の源

このページはプラグインの src/definitions.ts. 公開 API がアップストリームで変更された場合に、再度同期を実行してください。

Getting Started から続けてください

Capgo を使用している場合 Getting Started からダッシュボードと API の作業を計画するには、接続してください。 API の概要 API の概要の実装詳細について導入導入の実装詳細について API のキー API のキーに関する実装詳細についてデバイスデバイスの実装詳細について、そしてバンドルバンドルの実装詳細について。