设置

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

提示

任何对这些设置的修改在 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

在使用即时应用模式（"atInstall", "onLaunch"，包括已弃用的 "always"）时必填。安装并设置 directUpdate 并设置 @capacitor/splash-screen 启用后，插件在更新应用或无需更新时隐藏启动屏幕。 这消除了手动监听appReady事件并调用SplashScreen.hide()的需要。 launchAutoHide: false适用于Android和iOS。

默认值：

__CAPGO_KEEP_0__.config.json false

capacitor.config.json

{
  "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 : 和（And） @capacitor/splash-screen 与 launchAutoHide: false.

可在 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 字符串模式代替： "atInstall", "onLaunch"，或。 此选项仍支持现有应用程序。 应立即应用应上传 "always"以免更新影响用户体验。这些模式需要 --delta string modes autoSplashscreen: true 和 @capacitor/splash-screen 与 launchAutoHide: false.

选项:

• 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

Configure the public key for end to end live update encryption Version 2.

可在 Android、iOS 和 Electron 上使用。

默认值： undefined

capacitor.config.json

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

注意

publicKey 配置 Encryption V2，必须与上传时使用的私钥匹配。对于 Delta 更新，请使用 V2 加密，并启用部分加密，并且如果您的组织要求每次上传都加密，请启用加密包封装。不要依赖 publicKey 作为服务器端策略来防止未加密的 Delta 被发布。

resetWhenUpdate

自动删除设备上安装的新本机应用程序包时下载的以前的包。

可在 Android、iOS 和 Electron 上使用。

默认值： 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 上使用。设置为 "" 以禁用显式统计报告通过 /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 的网络应用程序中配置

而无需发布原生应用程序。

标题为“继续从设置” 如果您正在使用 to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater capgo操作，连接它到使用@capgo/capacitor-updater API 简介 为 API 简介 中的实现细节 介绍 为介绍 中的实现细节 API 密钥 为 API 密钥 中的实现细节,并且 设备 为设备 中的实现细节。