autoUpdater

autoUpdater

使应用程序能够自动更新

请参阅：在应用程序中如何实现更新的详细指南。

autoUpdater是一个EventEmitter.

跨平台提醒

目前只支持 macOS 和 Windows 版本。在 Linux 上没有内置的自动更新程序，因此建议使用发行版包管理器来更新您的应用程序。

此外，每个平台都有一些细微的差别:

在macOS上, autoUpdater模块建立在 Squirrel.Mac上,这意味着你不需要任何特殊的设置来使它工作。对于服务器端要求, 你可以阅读 Server Support. 注意App Transport Security (ATS) 适用于所有请求作为更新过程的一部分。</0> 如需禁用ATS的应用程序可以在其应用程序的plist中添加 NSAllowsArbitraryLoads属性。

注意： 在 macOS 上，您的应用程序必须得到签名后方可自动更新。这是 Squirrel.Mac 的要求。

Windows

在 Windows 上, 你必须将应用程序安装在用户的计算机上才能使用autoUpdater, 所以推荐使用 electron-winstaller, electron-forge 或者 grunt-electron-installer 模块来生成Windows安装程序。

当使用 electron-winstaller 或 electron-forge 时，请确保不要在第一次运行你的应用程序时进行更新操作(也可查看这个 issue获取更多信息)。还建议使用 electron-squirrel-startup 来创建应用程序的桌面快捷方式。

使用Squirrel生成的安装程序将以 com.squirrel.PACKAGE_ID.YOUR_EXE_WITHOUT_DOT_EXE 的格式创建一个带有 Application User Model ID.aspx) 的快捷图标，例子是 com.squirrel.slack.Slack 和 com.squirrel.code.Code。你应该在自己的应用中使用 app.setAppUserModelId API 方法设置相同的 API和ID，不然 Windows 将不能正确地把你的应用固定在任务栏上。

Like Squirrel.Mac, Windows can host updates on S3 or any other static file host. 你可以阅读 Squirrel.Windows的文档来获得更多关于 Squirrel.Windows 是如何工作的信息。

事件

autoUpdater 对象会触发以下的事件:

Event: ‘error’

error Error

当更新发生错误的时候触发。

event Event
releaseNotes String
releaseName String
releaseDate Date
updateURL String

在更新下载完成的时候触发。

在 Windows 上只有 releaseName 是有效的。

注意： 此事件并不一定需要处理。成功下载的更新仍将在应用程序下次启动时应用。

选项 对象
- url String
- headers Record<String, String> (可选) macOS - HTTP 请求头。
- serverType String(可选) macOS - 可以是json 或者 default,查看 Squirrel.Mac 的README文件获取更多详细信息。

设置检查更新的 url，并且初始化自动更新。

注意: 严格来讲，执行一次自动更新不一定要调用此方法。因为下载更新文件成功之后，下次应用启动的时候会强制更新。

autoUpdater

autoUpdater

跨平台提醒

macOS

Windows

事件

Event: ‘error’

Event: ‘checking-for-update’

Event: ‘update-available’

Event: ‘update-not-available’

Event: ‘update-downloaded’

Event: ‘before-quit-for-update’

方法

`autoUpdater.setFeedURL(选项)`

`autoUpdater.getFeedURL()`

`autoUpdater.checkForUpdates()`

`autoUpdater.quitAndInstall()`