设置

要对更新系统有更细致的控制，您可以使用以下设置进行配置：

提示

这些设置的任何更改都需要在 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。查看 数据位置.

allowModifyUrl

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

适用于 Android、iOS 和 Electron。

默认值： 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 values are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.

值仍支持为向后兼容。 需要安装并配置@__CAPGO_KEEP_0__/splash-screen插件，launchAutoHide设置为false。 需要启用自动更新。

可用于Android、iOS和Electron。 默认： false

capacitor.config.json

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

autoUpdate

配置插件如何检查、下载和应用实时更新。 插件在应用进入前台时检查更新，并在应用保持打开时重复定时器。 控制定时器间隔。 布尔值仍支持为向后兼容： periodCheckDelay controls that timer interval. Boolean values are still supported for backward compatibility: 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 上使用。

Default: https://plugin.capgo.app/channel_self

capacitor.config.json

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

defaultChannel

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

可用于 Android、iOS 和 Electron。

Default: undefined

capacitor.config.json

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

directUpdate

已弃用。使用 autoUpdate string 模式代替： "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日志。如果为真，插件将不会在JavaScript控制台中记录日志。只有原生日志会被执行。

可用于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

Configure the public key for end to end live update encryption Version 2.

可在 Android、iOS 和 Electron 上使用。

Default: undefined

capacitor.config.json

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

注意

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

resetWhenUpdate

在设备安装新版本的原生应用包时，自动删除之前下载的包。

可在 Android、iOS 和 Electron 上使用。

Default: true

capacitor.config.json

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

responseTimeout

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

可用于 Android、iOS 和 Electron。

Default: 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。请参阅 合规 为字段级别的分解.

Default: https://plugin.capgo.app/stats

capacitor.config.json

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

updateUrl

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

可用于Android、iOS和Electron.

Default: 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使用本地服务器进行测试或自托管更新服务器。

默认： undefined

capacitor.config.json

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

localSupaAnon

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

默认： 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 应用程序中 有更多的设置可供配置，且不需要发布原生应用程序。

继续从设置

如果您正在使用 设置 来规划仪表板和API操作， Using @capgo/capacitor-updater 使用 @capgo/capacitor-updater、 API Overview 在API Overview中实现详细信息 Introduction 在Introduction中实现详细信息 API Keys 在API Keys中实现详细信息，和 Devices 在Devices中实现详细信息。