设置

要对更新系统进行更精细的控制,您可以使用以下设置进行配置:

提示

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

appReadyTimeout

配置原生插件在将更新视为”失败”之前应等待的毫秒数。

仅适用于 Android 和 iOS。

默认值: 10000 (10 秒)

capacitor.config.json

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

responseTimeout

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

仅适用于 Android 和 iOS。

默认值: 20 (20 秒)

capacitor.config.json

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

autoDeleteFailed

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

仅适用于 Android 和 iOS。

默认值: true

capacitor.config.json

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

autoDeletePrevious

配置插件是否应在成功更新后自动删除之前的 bundle。

仅适用于 Android 和 iOS。

默认值: true

capacitor.config.json

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

autoUpdate

配置插件是否应通过更新服务器使用自动更新。

仅适用于 Android 和 iOS。

默认值: true

capacitor.config.json

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

updateUrl

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

仅适用于 Android 和 iOS。

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

capacitor.config.json

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

statsUrl

配置发送更新统计信息的 URL / 端点。

仅适用于 Android 和 iOS。设置为 "" 以禁用统计报告。

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

capacitor.config.json

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

publicKey

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

仅适用于 Android 和 iOS。

默认值: undefined

capacitor.config.json

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

directUpdate

配置插件何时应直接安装更新。仅适用于 autoUpdate 模式。 适用于小于 10MB 的应用以及使用 —partial 标志完成的上传。 Zip 或超过 10MB 的应用对用户来说更新会相对较慢。

选项:

• false: 永不执行直接更新(使用默认行为:启动时下载,后台时设置)
• 'atInstall': 仅在应用安装、从商店更新时直接更新,否则表现为 directUpdate = false
• 'onLaunch': 仅在应用安装、从商店更新或应用终止后直接更新,否则表现为 directUpdate = false
• 'always': 在所有先前情况下直接更新(应用安装、从商店更新、应用终止或应用恢复后),永不表现为 directUpdate = false
• true: (已弃用)与 “always” 相同,用于向后兼容

仅适用于 Android 和 iOS。

默认值: false

capacitor.config.json

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

resetWhenUpdate

当较新的原生应用 bundle 安装到设备时,自动删除之前下载的 bundle。

仅适用于 Android 和 iOS。

默认值: true

capacitor.config.json

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

defaultChannel

在配置中设置应用的默认频道。区分大小写。 此设置将覆盖云中设置的默认频道,但仍会遵守云中所做的覆盖。

仅适用于 Android 和 iOS。

默认值: undefined

capacitor.config.json

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

appId

在配置中配置应用的应用 ID。

仅适用于 Android 和 iOS。

默认值: undefined

capacitor.config.json

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

version

配置应用的当前版本。这将用于第一个更新请求。 如果未设置,插件将从原生代码获取版本。

仅适用于 Android 和 iOS。

默认值: undefined

capacitor.config.json

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

channelUrl

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

仅适用于 Android 和 iOS。

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

capacitor.config.json

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

autoSplashscreen

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

仅适用于 Android 和 iOS。

默认值: false

capacitor.config.json

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

periodCheckDelay

配置定期更新检查的延迟时间。单位为秒。 不能少于 600 秒 (10 分钟)。

仅适用于 Android 和 iOS。

默认值: 600 (10 分钟)

capacitor.config.json

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

allowModifyUrl

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

仅适用于 Android 和 iOS。

默认值: false

capacitor.config.json

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

keepUrlPathAfterReload

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

警告

触发重新加载时,‘window.history’ 将被清除。

仅适用于 Android 和 iOS。

默认值: false

capacitor.config.json

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

disableJSLogging

禁用插件的 JavaScript 日志记录。如果为 true,插件将不会记录到 JavaScript 控制台。只会执行原生日志。

仅适用于 Android 和 iOS。

默认值: false

capacitor.config.json

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

shakeMenu

启用摇动手势以显示更新菜单,用于调试/测试目的。

仅适用于 Android 和 iOS。

默认值: false

capacitor.config.json

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

开发设置

localHost

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

默认值: undefined

capacitor.config.json

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

localWebHost

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

默认值: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "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"
    }
  }
}

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

提示

Capgo Web 应用中还有其他可用的设置,可以按频道配置,无需发布原生应用。