设置

如果您想对更新系统有更细致的控制，可以通过这些设置来配置它：

提示

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

allowModifyUrl

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

可在 Android、iOS 和 Electron 上使用。

默认： false

capacitor.config.json

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

appId

配置应用 ID 以在配置中为应用配置应用 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

Configure whether the plugin should automatically delete previous bundles after a successful update.

可在 Android、iOS 和 Electron 上使用.

Default: true

capacitor.config.json

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

autoSplashscreen

自动处理使用直接更新时的启动屏幕隐藏。当启用时，插件将在应用程序更新后或无需更新时自动隐藏启动屏幕。 这消除了手动监听 appReady 事件并调用 SplashScreen.hide() 的需要。 仅在直接更新设置为“atInstall”，“always”，或 true 时有效。 需要安装并配置 @capacitor/splash-screen 插件，launchAutoHide 设置为 false。 需要启用 autoUpdate 和 directUpdate。

可在 Android、iOS 和 Electron 上使用.

Default: false

capacitor.config.json

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

autoUpdate

配置插件是否使用自动更新服务。

可在 Android、iOS 和 Electron 中使用。

默认值： true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

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

配置插件何时应该直接安装更新。仅适用于自动更新模式。 适用于小于 10MB 的应用程序以及使用 —delta 标志上传的应用程序。 对于大于 10MB 的 zip 或应用程序，用户更新速度相对较慢。 选项：

：永不进行直接更新（使用默认行为：下载时启动，设置时背景化）

• false：仅在应用程序安装、更新时从商店时进行直接更新，否则行为如 directUpdate = false
• 'atInstall'：仅在应用程序安装、更新时从商店或应用程序杀死后进行直接更新，否则行为如 directUpdate = false
• 'onLaunch'：在所有上述情况下（应用程序安装、更新时从商店、应用程序杀死或应用程序恢复）进行直接更新，永不行为如 directUpdate = false
• 'always'：仅在应用程序安装、更新时从商店或应用程序杀死后进行直接更新，否则行为如 directUpdate = false
• true: (deprecated) Same as “always” for backward compatibility

可在 Android、iOS 和 Electron 上使用。

默认值： false

capacitor.config.json

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

disableJSLogging

禁用插件的 JavaScript 日志。如果为 true，插件将不会在 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

配置终端到终端实时更新加密的公共密钥，版本 2

可在 Android、iOS 和 Electron 上使用

默认： undefined

capacitor.config.json

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

resetWhenUpdate

自动删除设备上安装的新 native 应用程序包时，删除之前下载的包

标题：重置更新

默认值： 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 上使用。设置为 "" 以禁用统计报告。

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

默认值： 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应用程序中找到更多设置，可以根据渠道进行配置，而无需发布原生应用程序。