设置

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

提示

这些设置中的任何更改都需要在 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

适用于 Android、iOS 和 Electron。

默认：

__CAPGO_KEEP_0__.config.json 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 值仍支持为向后兼容。 需要安装并配置@capacitor/splash-screen插件，launchAutoHide设置为false。 需要启用自动更新。

适用于Android、iOS和Electron。

默认值： false

capacitor.config.json

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

autoUpdate

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

或

• "off" 禁用自动更新检查 false或
• "atBackground" 在每次前台检查后自动检查和下载更新，然后在应用切换到后台时应用更新 true: Check and download automatically on each foreground check, then apply the update the next time the app moves to background
• "atInstall": 立即应用仅在新安装或原生应用商店更新后;否则使用 "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 日志。如果为 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"
    }
  }
}

注意事项

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 仍然启用 /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应用程序中，还有更多的设置可用 Capgo web app 继续从设置

标题为“继续从设置”

设置 Settings 为计划仪表板和API操作，连接它 使用@capgo/capacitor-updater 为本地能力的原理在使用@capgo/capacitor-updater API概述 为API概述的实现细节 简介 为简介的实现细节 API密钥 为API密钥的实现细节，并且 设备 为设备的实现细节。