Inicio

Instalar

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

Importar

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

API Resumen

activate

Hacer disponible la última configuración recuperada para los getters.

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

await FirebaseRemoteConfig.activate();

fetchAndActivate

Realizar operaciones de fetch y activación.

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

await FirebaseRemoteConfig.fetchAndActivate();

fetchConfig

Recuperar y cachear la configuración desde el servicio de Configuración Remota.

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

await FirebaseRemoteConfig.fetchConfig();

getBoolean

Obtener el valor para la clave dada como un booleano.

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

await FirebaseRemoteConfig.getBoolean({} as GetBooleanOptions);

getNumber

Obtenga el valor para la clave dada como un número.

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

await FirebaseRemoteConfig.getNumber({} as GetNumberOptions);

getString

Obtenga el valor para la clave dada como una cadena.

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

await FirebaseRemoteConfig.getString({} as GetStringOptions);

getInfo

Obtenga información sobre la última operación de fetch.

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

await FirebaseRemoteConfig.getInfo();

setMinimumFetchInterval

Establezca el intervalo de fetch mínimo.

Solo disponible para Web.

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

await FirebaseRemoteConfig.setMinimumFetchInterval({} as SetMinimumFetchIntervalOptions);

setSettings

Establecer los ajustes de configuración remota.

En Android, los valores de ajustes se persisten en SharedPreferences.

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

await FirebaseRemoteConfig.setSettings({} as SetSettingsOptions);

addConfigUpdateListener

Agregar un oyente para el evento de actualización de configuración.

Solo disponible para Android e iOS.

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

await FirebaseRemoteConfig.addConfigUpdateListener({} as AddConfigUpdateListenerOptionsCallback);

removeConfigUpdateListener

Eliminar un oyente para el evento de actualización de configuración.

Solo disponible para Android e iOS.

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

await FirebaseRemoteConfig.removeConfigUpdateListener({} as RemoveConfigUpdateListenerOptions);

Referencia de tipos

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;

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ruta la sincronización cuando el público API cambie en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard y API operaciones, conecta con API Overview para el detalle de implementación en API Resumen Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.