设置

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

提示

这些设置中的任何更改都需要在 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". 支持向后兼容的旧值。 需要安装并配置@__CAPGO_KEEP_0__/splash-screen插件，launchAutoHide设置为false。 需要启用自动更新。 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__.config.json false

capacitor.config.json

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

autoUpdate

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

选项:

• "off" 或 false: 禁用自动更新检查
• "atBackground" : 检查并下载每次前台检查后自动应用更新 true: 只在首次安装或原生应用商店更新后立即应用；否则使用
• "atInstall"__CAPGO_KEEP_0__ "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 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

配置用于端到端实时更新加密的公共密钥（Version 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

配置原生插件在考虑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 remains /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以使用本地服务器进行测试或自托管更新服务器。

默认： 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 应用

中找到更多设置，这些设置可以根据频道配置而无需发布原生应用。

标题：继续从设置 如果您正在使用 to plan dashboard and API operations, connect it with 使用@capgo/capacitor-updater 为本地能力在使用@capgo/capacitor-updater, API概述 为实现细节在API概述, 简介 为实现细节在简介, API密钥 为实现细节在API密钥,并且 设备 为实现细节在设备。