设置

为了拥有更细致的控制权，更新系统，您可以使用这些设置进行配置：

提示

任何对这些设置的更改在 capacitor.config 文件中，需要同步平台并发布到商店，生产应用才能接收到它们。

注意

需要 EU 数据存储空间的 Capgo 云？设置 updateUrl 到 https://plugin.eu.capgo.app/updates, statsUrl 到 https://plugin.eu.capgo.app/stats到 channelUrl . 看 https://plugin.eu.capgo.app/channel_self数据位置 允许插件从 JavaScript 端动态修改 updateUrl、statsUrl 和 channelUrl。.

allowModifyUrl

默认：

__CAPGO_KEEP_0__.config.json

允许插件从 JavaScript 端动态修改 updateUrl、statsUrl 和 channelUrl。 false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

配置应用 ID

可用于 Android、iOS 和 Electron

默认值: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

配置 native 插件在等待更新失败之前等待的毫秒数

可用于 Android、iOS 和 Electron

默认值: 10000 (10 秒)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

配置插件是否自动删除失败的包。

适用于 Android、iOS 和 Electron。

默认： true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

配置插件是否在更新成功后自动删除上一个版本的包。

适用于 Android、iOS 和 Electron。

默认： true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

自动处理启动屏幕隐藏，当使用即时应用模式时。当启用时，插件将在更新应用或无需更新时自动隐藏启动屏幕。 这消除了手动监听appReady事件并调用SplashScreen.hide()的需要。 仅在 autoUpdate 设置为 "atInstall", "onLaunch"，或 "always"。遗留 directUpdate 值仍支持为向后兼容。 需要@capacitor/splash-screen插件安装并配置launchAutoHide：false。 需要启用自动更新。

适用于Android、iOS和Electron。

默认值： false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

autoUpdate

配置插件如何检查、下载和应用实时更新。 插件在应用切换到前台时检查更新，并在应用保持打开时以重复的时间间隔检查更新。 periodCheckDelay 控制该时间间隔。 为了向后兼容，仍支持布尔值: true 与 "atBackground" 与 false 。 字符串值合并了之前的自动更新和直接更新配置。 "off"选项:

或

• "off" 禁用自动更新检查 false或
• "atBackground" : 检查并下载每次前台检查时自动下载，然后在应用下次切换到后台时应用更新 true或
• "atInstall": 立即应用仅在新安装或原生应用商店更新后; 否则使用 "atBackground" 行为
• "onLaunch": 立即应用仅当应用从杀死状态（冷启动）被唤醒时; 之后第一次检查后，回退到 "atBackground" 行为
• "always": 每次前台转换时检查，并立即应用更新时
• "onlyDownload": 检查并下载自动，发射 updateAvailable, 并且永远不会设置下一个捆绑包或自动应用更新

可在 Android、iOS 和 Electron 上使用。

默认: "atBackground" (true 仍然被接受)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

配置频道操作的URL/端点。

适用于Android、iOS和Electron。

默认值： https://plugin.capgo.app/channel_self

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

defaultChannel

设置应用程序在配置中的默认频道。区分大小写。 此设置将覆盖云端设置的默认频道，但仍会尊重云端设置的覆盖。

适用于Android、iOS和Electron。

默认值： undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

已弃用。请使用 autoUpdate 使用字符串模式代替: "atInstall", "onLaunch",或 "always" 此选项仍支持现有应用程序。

选项:

• false: 从未进行直接更新
• 'atInstall': 与 autoUpdate: "atInstall"
• 'onLaunch': 与 autoUpdate: "onLaunch"
• 'always': 与 autoUpdate: "always"
• true: (已弃用) 与 "always" 保留兼容性

可在 Android、iOS 和 Electron 上使用。

默认值： false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

禁用插件的 JavaScript 日志。如果为 true，插件将不会在 JavaScript 控制台中记录日志。仅 native 日志会被执行。

可在 Android、iOS 和 Electron 上使用。

默认值： false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

配置插件以在重新加载后保留 URL 路径。

注意

当触发重新加载时，‘window.history’会被清除。

适用于 Android、iOS 和 Electron。

默认值： false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

配置周期更新检查的延迟时间。单位为秒。不能小于 600 秒（10 分钟）。

适用于 Android、iOS 和 Electron。

默认值： 600 （10 分钟）

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

用于端到端实时更新加密（版本 2）的公共密钥配置

可用于 Android、iOS 和 Electron

默认值： undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

注意

publicKey 配置了加密 V2，并且必须与上传时使用的私钥匹配。对于 Delta 更新，请使用 V2 加密并启用部分加密，并在您的组织要求每次上传都加密时启用加密包封装。不要依赖 publicKey 作为服务器端策略来防止未加密的 Delta 被发布

resetWhenUpdate

当更新时自动删除设备上安装的之前下载的包。

可用于 Android、iOS 和 Electron。

默认值： true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

配置 native 插件在等待 API 超时之前等待的毫秒数。

可用于 Android、iOS 和 Electron。

默认值： 20 (20 秒)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

通过摇动手势来显示更新菜单，用于调试/测试目的。

可用于 Android、iOS 和 Electron。

默认值： false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

配置更新统计数据发送到的 URL 或端点。

可用于 Android、iOS 和 Electron。设置为 "" 来禁用显式统计数据报告通过 /stats.

禁用 statsUrl 不禁用所有Capgo设备存储。如果 updateUrl 仍然启用 /updates 仍然存储了计费 MAU 行、设备清单和更新决策事件数据，以便提供更新和计算 MAU。请参见 遵从性 获取字段级别的详细信息。

默认值： https://plugin.capgo.app/stats

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

配置更新检查发送到的 URL/端点。

可用于 Android、iOS 和 Electron。

默认值： https://plugin.capgo.app/updates

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

配置当前应用的版本。这将用于第一个更新请求。 如果未设置，插件将从本地code获取版本。

可用于Android、iOS和Electron。

默认值: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

开发设置

localApi

配置CLI使用本地api进行测试。

默认值: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

配置CLI使用本地文件api进行测试。

默认值: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

配置CLI使用本地服务器进行测试或自主更新服务器。

默认值: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

配置CLI以使用本地服务器进行测试或自托管更新服务器。

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

配置CLI以使用本地服务器进行测试。

Default: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

配置CLI以使用本地服务器进行测试或自托管更新服务器。

默认: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

提示

在 Capgo Web 应用程序中，还有更多的设置可用。 Capgo web app 继续从设置

标题：继续从设置

设置 设置 为计划仪表板和API操作，连接它 使用@capgo/capacitor-updater 对于本地能力的使用@capgo/capacitor-updater API概述 对于API概述的实现细节 简介 对于简介的实现细节 API密钥 对于API密钥的实现细节，并且 设备 对于设备的实现细节。