Firebase 远程配置插件

非官方电容插件 远程配置[^1]

使用大小写

Firebase远程配置插件通常用于改变您的应用程序的行为和外观,而不发布应用程序更新,例如:

• 地物标志:通过远程取出布尔参数,逐步推出新特性.
• 晋升: 远程启动销售或促销,例如通过 is_sale 参数.
• 维修通知:向用户通报即将进行的维护,而不发布新的应用版本.
• 实时更新: 使用配置更新收听器实时对配置变化进行响应.
• 默认值: 提供应用中的默认值, 这样您的应用程序在第一次获取前可以预测到行为 .

兼容性

指南

• 带有远程配置的 Capacitor App 中的特性旗: 特性旗, 已相继推出, 以及此插件的实时配置更新 .
• 如何在电容App中使用火把: 如何将特征旗插入家庭的其余部分,包括他们针对的Analytics受众.

安装

你可以用我们的 AI 辅助设置 以安装插件. 添加数据 超级技能 至您的 AI 工具,使用以下命令:

npx skills add capawesome-team/skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/remote-config` plugin in my project.

如果你喜欢 手动设置,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capacitor-firebase/remote-config firebase
npx cap sync

如果您还没有将 Firebase 添加到您的项目中(机器人 编号 : iOS系统 编号 : 网页) (中文(简体) ).

机器人

需要谷歌分析 有条件选择应用实例 用于用户属性和受众。 确定您安装 电容火碱分析 工程中的插件 .

变量

如果需要, 您可以在您的应用程序中定义以下工程变量 variables.gradle 要更改依赖的默认版本的文件 :

• $firebaseConfigVersion 版本 com.google.firebase:firebase-config (默认 : 23.0.1(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

iOS系统

Swift 软件包管理器

在您的 capacitor.config.json (或 capacitor.config.ts) 避免 SwiftPM 软件包识别相撞数字 :

{
  "experimental": {
    "ios": {
      "spm": {
        "packageOptions": {
          "@capacitor-firebase/remote-config": {
            "symlink": true
          }
        }
      }
    }
  }
}

请注意目标 packageOptions 支持需要控制器 CLI 8.4.0+ (中文(简体) )。 。 。 .

配置

此插件不需要配置 .

演示

这里有一个实例: robingenz/电容器-火力基地-插座-demo

启动模板

以下启动模板可供使用:

• 角起火点

使用量

以下示例显示如何获取并激活配置,读取配置值,配置获取行为,设置自定义信号,并实时收听配置更新.

获取并激活配置

从远程配置服务中获取最新配置并激活,使其提供给获取者. 使用 fetchAndActivate() 立即执行两项行动。 在Android和iOS上,您可以通过最小的获取间隔到 fetchConfig(...)数字 :

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

const fetchConfig = async () => {
  await FirebaseRemoteConfig.fetchConfig({
    minimumFetchIntervalInSeconds: 1200,
  });
};

const activate = async () => {
  await FirebaseRemoteConfig.activate();
};

const fetchAndActivate = async () => {
  await FirebaseRemoteConfig.fetchAndActivate();
};

读取配置值

将给定键的值读取为布尔、数字或字符串 :

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

const getBoolean = async () => {
  const { value } = await FirebaseRemoteConfig.getBoolean({
    key: 'is_sale',
  });
  return value;
};

const getNumber = async () => {
  const { value } = await FirebaseRemoteConfig.getNumber({
    key: 'upcoming_maintenance',
  });
  return value;
};

const getString = async () => {
  const { value } = await FirebaseRemoteConfig.getString({
    key: 'license_key',
  });
  return value;
};

配置获取行为

设定获取超时和最小获取间隔 。 在开发过程中,建议设定相对较低的最小取取间隔:

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

const setSettings = async () => {
  await FirebaseRemoteConfig.setSettings({
    fetchTimeoutInSeconds: 10,
    minimumFetchIntervalInSeconds: 0,
  });
};

设置自定义信号

设置应用程序实例的自定义信号, 用于远程配置条件下的目标设定 。 带有信号的信号 null 将删除值 :

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

const setCustomSignals = async () => {
  await FirebaseRemoteConfig.setCustomSignals({
    customSignals: {
      city: 'Berlin',
      preferred_event_category: 'concerts',
    },
  });
};

实时监听配置更新

为配置更新事件添加一个监听器,一旦参数值发生变化,将立即通知。 仅在Android和iOS上提供:

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

const addConfigUpdateListener = async () => {
  const callbackId = await FirebaseRemoteConfig.addConfigUpdateListener(
    (event, error) => {
      if (error) {
        console.error(error);
      } else {
        console.log(event);
      }
    }
  );
  return callbackId;
};

const removeConfigUpdateListener = async (callbackId: string) => {
  await FirebaseRemoteConfig.removeConfigUpdateListener({
    callbackId,
  });
};

删除所有听众

删除所有为此插件添加的听众 :

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

const removeAllListeners = async () => {
  await FirebaseRemoteConfig.removeAllListeners();
};

API 密码

• activate()
• fetchAndActivate()
• fetchConfig(...)
• getBoolean(...)
• getNumber(...)
• getString(...)
• getAll()
• getInfo()
• setMinimumFetchInterval(...)
• setCustomSignals(...)
• setDefaults(...)
• setSettings(...)
• addConfigUpdateListener(...)
• removeConfigUpdateListener(...)
• removeAllListeners()
• 接口
• 类型异名
• 数字

激活( c)

activate() => Promise<void>

向获取者提供上次获取的配置 .

自: 1.3.0 (单位:千美元)

获取And Activate ()

fetchAndActivate() => Promise<void>

执行获取并激活操作 .

自: 1.3.0 (单位:千美元)

获取 Config (...)

fetchConfig(options?: FetchConfigOptions | undefined) => Promise<void>

从远程配置服务获取并缓存配置 .

自: 1.3.0 (单位:千美元)

获取 Boolean (...)

getBoolean(options: GetBooleanOptions) => Promise<GetBooleanResult>

获取给定的密钥作为布尔值 .

回返情况: Promise<GetBooleanResult>

自: 1.3.0 (单位:千美元)

获取数字(...)

getNumber(options: GetNumberOptions) => Promise<GetNumberResult>

获取给定密钥作为数字的值 .

回返情况: Promise<GetNumberResult>

自: 1.3.0 (单位:千美元)

获取 String (...)

getString(options: GetStringOptions) => Promise<GetStringResult>

获取给定键作为字符串的值 .

回返情况: Promise<GetStringResult>

自: 1.3.0 (单位:千美元)

获取全部( E)

getAll() => Promise<GetAllResult>

从远程配置服务中获取所有值 .

回返情况: Promise<GetAllResult>

自: 8.3.0 (单位:千美元)

获取信息 ()

getInfo() => Promise<GetInfoResult>

获取上次获取操作的信息 .

回返情况: Promise<GetInfoResult>

自: 7.5.0 (中文(简体) )

设置最小切入(...)

setMinimumFetchInterval(options: SetMinimumFetchIntervalOptions) => Promise<void>

设定最小获取间隔 .

仅供Web使用.

自: 1.3.0 (单位:千美元)

设置自定义符号(...)

setCustomSignals(options: SetCustomSignalsOptions) => Promise<void>

设置应用程序实例的自定义信号, 用于远程配置条件下的目标设定 .

自: 8.4.0 (单位:百万美元)

默认值(...)

setDefaults(options: SetDefaultsOptions) => Promise<void>

在默认的名称空间配置中设置参数密钥和值的配置默认值.

自: 8.3.0 (单位:千美元)

设置设置(...)

setSettings(options: SetSettingsOptions) => Promise<void>

设置远程配置设置 .

在Android上,设置值在"共享优先"中被坚持.

自: 6.2.0 (单位:千美元)

添加 Config Update 倾听器(...)

addConfigUpdateListener(callback: AddConfigUpdateListenerOptionsCallback) => Promise<CallbackId>

为配置更新事件添加一个收听器 .

仅供Android和iOS使用.

回返情况: Promise<string>

自: 5.4.0 (单位:千美元)

删除 Config Update 倾听器(...)

removeConfigUpdateListener(options: RemoveConfigUpdateListenerOptions) => Promise<void>

删除配置更新事件的听众 .

仅供Android和iOS使用.

自: 5.4.0 (单位:千美元)

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有听众 .

自: 5.4.0 (单位:千美元)

接口

获取配置选项

获取 Boolean 遗书

获取选项

获取数字结果

获取斯特林结果

获取全部结果

获取全部结果值

获取信息结果

设置最小切换间隔选项

设置自定义符号选项

设置默认选项

设置选项

添加Config Update 收听器可选回调程序

删除配置更新收听器选项

类型异名

获取 Boolean 选项

GetOptions

获取数字选项

GetOptions

获取 String 选项

GetOptions

添加Config Update 收听器可选调用

(event: AddConfigUpdateListenerOptionsCallbackEvent | null, error: any): void

调用文件夹

string

数字

获取值源

最后一个图像状态

财务问题

为什么获得者返回默认值而不是远程值?

获取的配置值必须在获取器可用之前激活 。 打电话 fetchConfig(...) 接下来是 activate(),或使用 fetchAndActivate() 如本报告所示,将同时开展这两项行动 使用示例 见上文.

插件多久获取新配置值 ?

获取的配置值被缓存 。 最小取取间隔定义了在被视作 stale 之前在配置缓存中一个条目的最大年龄以秒为单位,默认为43200秒(12小时). 在开发期间,建议使用 setSettings(...) 安卓与iOS或 setMinimumFetchInterval(...) 在网络上.

我对实时的配置变化有什么反应?

使用 addConfigUpdateListener(...) 当参数值发生变化时立即通知,包括更新了数值的密钥。 这种方法仅在Android和iOS上可用. 你可以再次删除听众 removeConfigUpdateListener(...) 或者说 removeAllListeners()。 。 。 .

我需要Firebase分析插件来使用远程配置吗?

Google Analytics只用于有条件地将应用实例瞄准用户属性和受众. 如果想要使用条件,请确保同时安装 电容火碱分析 工程中的插件 .

我怎么知道一个配置值是从哪里来的?

获取者返回a source 属性外加值。 它表示该值是否是静态默认值,是从客户端设定的默认取出,还是从Firebase远程配置服务器取出.

相关插件

• 火场分析: 记录带有Firebase分析器的事件和用户属性.
• 实时更新: 实时更新你的应用程序,而不要求用户从应用程序商店下载新版本.

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .

[^1]: 这个项目不附属于Google LLC或其任何子公司或子公司,也不获得其认可、支持、赞助或批准.