设置

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

提示

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

注意

需要欧盟数据存储能力的Capgo Cloud？设置 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

通过更新服务器配置插件如何使用自动更新。 true Boolean 值仍支持为向后兼容： "atBackground" 与 false 等同于 "off".

选项：

• "off" 或 false: 禁用自动更新
• "atBackground" 或 true: 检查并下载自动应用，应用程序切换到后台时应用
• "atInstall": 只在首次安装或原生应用更新后立即应用，否则使用 "atBackground"
• "onLaunch": 立即在启动时应用，否则使用 "atBackground" after the launch check
• "always": Apply immediately whenever Auto Update runs
• "onlyDownload": Check and download automatically, emit updateAvailable, and never set the next bundle automatically

Available on Android, iOS, and Electron.

Default: "atBackground" (true __CAPGO_KEEP_0__.config.json

capacitor.config.json

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

channelUrl

Configure the URL / endpoint for channel operations.

在 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 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 日志。如果为 true，插件将不会在 JavaScript 控制台中记录日志，只有原生日志会被记录。

可用于 Android、iOS 和 Electron。

默认： false

capacitor.config.json

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

keepUrlPathAfterReload

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

注意

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

可用于 Android、iOS 和 Electron。

Default: false

capacitor.config.json

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

periodCheckDelay

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

适用于 Android、iOS 和 Electron。

Default: 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"
    }
  }
}

resetWhenUpdate

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

可在 Android、iOS 和 Electron 上使用。

默认： true

capacitor.config.json

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

responseTimeout

配置原生插件在等待 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。设置为 "" 以禁用统计报告.

默认值： 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使用本地服务器或自主更新服务器进行测试。

Default: undefined

capacitor.config.json

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

提示

在 Capgo web 应用程序中 有更多的设置可供配置，且不需要发布原生应用程序即可根据频道进行配置。

继续从设置中

如果您正在使用 设置 来规划仪表板和API操作，连接它到 使用 @capgo/capacitor-updater 使用 @capgo/capacitor-updater 的原生能力 API 简介 使用 API 简介的实现细节 介绍 使用介绍的实现细节 API 密钥 使用 API 密钥的实现细节 设备 使用设备的实现细节