设置

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

提示

这些设置中的任何更改都需要在 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. 查看 数据位置.

为了使用您自己的主机名 updateUrl, statsUrl, 和 channelUrl, 查看 自定义域名设置.

allowModifyUrl

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

可在 Android、iOS 和 Electron 上使用。

默认： false

capacitor.配置文件

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

appId

配置应用 ID 以在配置中为应用设置。

可在 Android、iOS 和 Electron 上使用。

默认： undefined

capacitor.配置文件

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

appReadyTimeout

配置 native 插件在考虑更新失败之前等待的毫秒数。

可在 Android、iOS 和 Electron 上使用。

默认： 10000 (10 秒)

capacitor.配置文件

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

autoDeleteFailed

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

可在 Android、iOS 和 Electron 上使用。

默认： true

capacitor.配置文件

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

autoDeletePrevious

配置插件是否自动删除更新后之前的捆绑包。

可用于 Android、iOS 和 Electron。

默认值： true

capacitor.配置文件

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

autoSplashscreen

在使用即时应用模式（"atInstall", "onLaunch"，包括已弃用的 "always"）时必填。安装并设置 directUpdate 和 @capacitor/splash-screen 并设置 launchAutoHide: false可用于 Android、iOS 和 Electron。

可在 Android 和 iOS 上使用。

默认： false

capacitor.配置文件

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

配置插件如何检查、下载和应用实时更新。 插件在应用进入前台时检查更新，并在应用保持打开时重复检查。 periodCheckDelay 控制定时器间隔。 为了向后兼容，仍支持布尔值： true 等同于 "atBackground" 和 false 等同于 "off"。 字符串值合并了之前的自动更新和直接更新配置。

选项：

• "off" 或 false:禁用自动更新检查
• "atBackground" 或 true:每次前台检查时检查和下载更新，然后在下一次后台时应用更新
• "atInstall":仅在首次安装或原生应用商店更新后立即应用；否则使用 "atBackground" 行为
• "onLaunch":在从杀死状态（冷启动）将应用带到前台时立即应用；之后第一次检查后回退到 "atBackground" 行为
• "always":每次前台转换时检查，并在有更新时立即应用
• "onlyDownload":自动检查和下载更新，发出 updateAvailable,并且永远不设置下一个捆绑包或自动应用更新

立即应用模式（"atInstall", "onLaunch", "always") 在用户等待时应用。上传仅更改的文件。 npx @capgo/cli@latest bundle upload --delta 仅更改的文件下载。全压缩包上传会降低用户体验。Android 和 iOS 上这些模式需要 autoSplashscreen: true 和 @capacitor/splash-screen 与 launchAutoHide: false.

可在 Android、iOS 和 Electron 上使用。

默认值： "atBackground" (true 仍然被接受)

capacitor.配置文件

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

channelUrl

配置频道操作的 URL/端点

可在 Android、iOS 和 Electron 上使用。

Default: https://plugin.capgo.app/channel_self

capacitor.配置文件

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

defaultChannel

设置应用程序的默认频道在配置中。大小写敏感。 此设置将覆盖云中设置的默认频道，但仍将尊重云端的覆盖设置。

可用于Android、iOS和Electron。

Default: undefined

capacitor.配置文件

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

directUpdate

已弃用。使用 autoUpdate 字符串模式代替： "atInstall", "onLaunch", 或者 "always". 此选项仍支持现有应用。 即刻应用应与 --delta 以免更新过程中影响用户体验。这些模式需要 autoSplashscreen: true 和 @capacitor/splash-screen with launchAutoHide: false.

与

• false选项：
• 'atInstall': 不进行直接更新 autoUpdate: "atInstall"
• 'onLaunch': 不进行直接更新 autoUpdate: "onLaunch"
• 'always': 不进行直接更新 autoUpdate: "always"
• true: 与 "always" : (已弃用) 与

可在 Android、iOS 和 Electron 上使用。

默认： false

capacitor.配置文件

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

禁用插件的 JavaScript 日志。如果为 true，插件将不会在 JavaScript 控制台中记录日志。只有原生日志会被记录。

可在 Android、iOS 和 Electron 上使用。

默认： false

capacitor.配置文件

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

keepUrlPathAfterReload

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

注意事项

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

适用于Android、iOS和Electron。

默认值： false

capacitor.配置文件

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

periodCheckDelay

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

适用于Android、iOS和Electron。

默认值： 600 （10分钟）

capacitor.配置文件

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

publicKey

配置用于端到端live update加密的公共密钥，版本 2.

可用于 Android、iOS 和 Electron。

默认值： undefined

capacitor.配置文件

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

注意事项

publicKey 配置加密 V2，并且必须与上传时使用的私钥匹配。对于 Delta 更新，请使用 V2 加密并启用部分加密，并在您的组织要求每个上传都加密时启用加密包封装。如果您的组织要求每个上传都加密，请勿依赖此项作为服务器端策略来防止未加密的 Delta 被发布。 publicKey Configure the public key for end to end __CAPGO_KEEP_0__ encryption Version 2.

resetWhenUpdate

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

可用于 Android、iOS 和 Electron。

默认： true

capacitor.配置文件

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

responseTimeout

配置本机插件在等待 API 超时之前等待的毫秒数。

可用于 Android、iOS 和 Electron。

默认： 20 (20 秒)

capacitor.配置文件

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

shakeMenu

通过摇晃手势来显示更新菜单，用于调试/测试目的。

可用于Android、iOS和Electron。

默认值： false

capacitor.配置文件

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

statsUrl

配置更新统计数据发送到的URL/端点。

可用于Android、iOS和Electron。设置为""来禁用显式统计报告通过 /stats.

禁用 statsUrl 不禁用所有Capgo设备存储。如果 updateUrl 仍然启用 /updates 仍然存储计费 MAU 行、设备清单和更新决策事件数据，以便提供更新和计算 MAU。请参见 遵守性 了解字段级别的细节。

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

capacitor.配置文件

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

updateUrl

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

可用于 Android、iOS 和 Electron。

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

capacitor.配置文件

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

version

配置当前应用程序的版本。这将用于第一个更新请求。 如果未设置，插件将从本机 code 中获取版本。

适用于 Android、iOS 和 Electron。

默认值： undefined

capacitor.配置文件

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

开发设置

localApi

配置 CLI 使用本地 api 进行测试。

默认值： undefined

capacitor.配置文件

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

配置CLI使用本地文件api进行测试。

默认值： undefined

capacitor.配置文件

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

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

默认值： undefined

capacitor.配置文件

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

localSupa

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

默认： undefined

capacitor.配置文件

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

配置CLI以使用本地服务器进行测试。

默认： undefined

capacitor.配置文件

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

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

默认值： undefined

capacitor.配置文件

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

提示

您还可以在__CAPGO_KEEP_0__ web应用中找到更多设置 Capgo 网页应用 继续从设置

标题：继续从设置

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