应用程序

控制应用程序的事件生命周期。

以下示例展示了当最后一个窗口关闭时如何退出应用程序

const { app } = require('electron')
app.on('window-all-closed', () => {
  app.quit()
})

事件

app 对象会发出以下事件

事件：'will-finish-launching'

当应用程序完成基本启动时发出。在 Windows 和 Linux 上，will-finish-launching 事件与 ready 事件相同；在 macOS 上，此事件表示 NSApplication 的 applicationWillFinishLaunching 通知。

在大多数情况下，你应该在 ready 事件处理程序中执行所有操作。

事件：'ready'

event 事件
launchInfo 记录<字符串，任意> | NotificationResponse macOS

当 Electron 完成初始化后发出一次。在 macOS 上，launchInfo 保存 NSUserNotification 的 userInfo 或 UNNotificationResponse 中的信息，用于在从通知中心启动应用程序时打开应用程序。你还可以调用 app.isReady() 来检查此事件是否已触发，并调用 app.whenReady() 来获取在 Electron 初始化时实现的 Promise。

事件：'window-all-closed'

当所有窗口都已关闭时发出。

如果你不订阅此事件并且所有窗口都已关闭，则默认行为是退出应用程序；但是，如果你订阅，则可以控制应用程序是否退出。如果用户按下了 Cmd + Q，或开发者调用了 app.quit()，Electron 将首先尝试关闭所有窗口，然后发出 will-quit 事件，在这种情况下，将不会发出 window-all-closed 事件。

事件：'before-quit'

event 事件

在应用程序开始关闭其窗口之前发出。调用 `event.preventDefault()` 将阻止默认行为，即终止应用程序。

注意：如果应用程序退出是由 `autoUpdater.quitAndInstall()` 发起的，那么 `before-quit` 会在所有窗口上发出 `close` 事件并关闭它们之后发出。

注意：在 Windows 上，如果应用程序因系统关机/重启或用户注销而关闭，则不会发出此事件。

事件：'will-quit'

event 事件

当所有窗口都已关闭且应用程序将退出时发出。调用 `event.preventDefault()` 将阻止默认行为，即终止应用程序。

请参阅 `window-all-closed` 事件的说明，了解 `will-quit` 和 `window-all-closed` 事件之间的差异。

注意：在 Windows 上，如果应用程序因系统关机/重启或用户注销而关闭，则不会发出此事件。

事件：'quit'

event 事件
exitCode 整数

当应用程序退出时发出。

注意：在 Windows 上，如果应用程序因系统关机/重启或用户注销而关闭，则不会发出此事件。

事件：'open-file' macOS

event 事件
path 字符串

当用户希望使用应用程序打开文件时发出。`open-file` 事件通常在应用程序已打开且操作系统希望重用应用程序打开文件时发出。当文件被拖放到 Dock 中且应用程序尚未运行时，也会发出 `open-file`。确保在应用程序启动的早期侦听 `open-file` 事件以处理此情况（甚至在发出 `ready` 事件之前）。

如果您想处理此事件，则应调用 `event.preventDefault()`。

在 Windows 上，您必须解析 `process.argv`（在主进程中）以获取文件路径。

事件：'open-url' macOS

event 事件
url 字符串

当用户希望使用应用程序打开 URL 时发出。应用程序的 Info.plist 文件必须在 CFBundleURLTypes 键中定义 URL 方案，并将 NSPrincipalClass 设置为 AtomApplication。

与 open-file 事件一样，务必在应用程序启动的早期为 open-url 事件注册一个侦听器，以检测应用程序是否正在打开以处理 URL。如果您在响应 ready 事件时注册侦听器，您将错过触发应用程序启动的 URL。

事件：'activate' macOS

event 事件
hasVisibleWindows 布尔值

当应用程序被激活时发出。各种操作都可以触发此事件，例如首次启动应用程序、尝试在应用程序已运行时重新启动应用程序，或单击应用程序的 Dock 或任务栏图标。

事件：'did-become-active' macOS

event 事件

当应用程序变为活动状态时发出。这与 activate 事件不同，因为 did-become-active 在每次应用程序变为活动状态时发出，而不仅仅是在单击 Dock 图标或重新启动应用程序时发出。当用户通过 macOS 应用程序切换器切换到应用程序时，也会发出此事件。

事件：'did-resign-active' macOS

event 事件

当应用程序不再处于活动状态且没有焦点时发出。例如，可以通过单击另一个应用程序或使用 macOS 应用程序切换器切换到另一个应用程序来触发此事件。

事件：'continue-activity' macOS

event 事件
type 字符串 - 标识活动的字符串。映射到 NSUserActivity.activityType。
userInfo 未知 - 包含活动在其他设备上存储的特定于应用程序的状态。
details 对象
- webpageURL 字符串（可选） - 标识活动在其他设备上访问的网页 URL 的字符串（如果可用）。

当来自其他设备的活动想要恢复时，在 Handoff 期间发出。如果您想要处理此事件，则应调用 event.preventDefault()。

用户活动只能在具有与活动源应用程序相同的开发者团队 ID 且支持活动类型的应用程序中继续。在应用程序的 Info.plist 中的 NSUserActivityTypes 键下指定支持的活动类型。

事件：'will-continue-activity' macOS

event 事件
type 字符串 - 标识活动的字符串。映射到 NSUserActivity.activityType。

当来自其他设备的活动想要恢复之前，在 Handoff 期间发出。如果您想要处理此事件，则应调用 event.preventDefault()。

事件：'continue-activity-error' macOS

event 事件
type 字符串 - 标识活动的字符串。映射到 NSUserActivity.activityType。
error 字符串 - 带有错误本地化描述的字符串。

当来自其他设备的活动无法恢复时，在 Handoff 期间发出。

事件：'activity-was-continued' macOS

event 事件
type 字符串 - 标识活动的字符串。映射到 NSUserActivity.activityType。
userInfo 未知 - 包含活动存储的特定于应用程序的状态。

在 Handoff 期间，当此设备上的活动在另一设备上成功恢复后发出。

事件：'update-activity-state' macOS

event 事件
type 字符串 - 标识活动的字符串。映射到 NSUserActivity.activityType。
userInfo 未知 - 包含活动存储的特定于应用程序的状态。

当 Handoff 即将在另一设备上恢复时发出。如果您需要更新要传输的状态，则应立即调用 event.preventDefault()，构建一个新的 userInfo 字典，并及时调用 app.updateCurrentActivity()。否则，操作将失败，并且将调用 continue-activity-error。

事件：'new-window-for-tab' macOS

event 事件

当用户点击本机 macOS 新标签按钮时发出。仅当当前 BrowserWindow 具有 tabbingIdentifier 时，新标签按钮才可见

事件：'browser-window-blur'

event 事件
window BrowserWindow

当 browserWindow 变为模糊时发出。

事件：'browser-window-focus'

event 事件
window BrowserWindow

当 browserWindow 获得焦点时发出。

事件：'browser-window-created'

event 事件
window BrowserWindow

当创建新的 browserWindow 时发出。

事件：'web-contents-created'

event 事件
webContents WebContents

当创建新的 webContents 时发出。

事件：'certificate-error'

event 事件
webContents WebContents
url 字符串
error 字符串 - 错误代码
certificate 证书
callback 函数
- isTrusted 布尔值 - 是否将证书视为受信任的
isMainFrame 布尔值

当无法验证 url 的 certificate 时发出，要信任证书，你应该使用 event.preventDefault() 来阻止默认行为并调用 callback(true)。

const { app } = require('electron')

app.on('certificate-error', (event, webContents, url, error, certificate, callback) => {
  if (url === 'https://github.com') {
    // Verification logic.
    event.preventDefault()
    callback(true)
  } else {
    callback(false)
  }
})

事件：'select-client-certificate'

event 事件
webContents WebContents
url URL
certificateList Certificate[]
callback 函数
- certificate Certificate（可选）

当请求客户端证书时发出。

url 对应于请求客户端证书的导航条目，并且可以使用从列表中筛选出的条目来调用 callback。使用 event.preventDefault() 可以防止应用程序使用存储中的第一个证书。

const { app } = require('electron')

app.on('select-client-certificate', (event, webContents, url, list, callback) => {
  event.preventDefault()
  callback(list[0])
})

event 事件
webContents WebContents
authenticationResponseDetails 对象
- url URL
authInfo 对象
- isProxy 布尔值
- scheme 字符串
- host 字符串
- port 整数
- realm 字符串
callback 函数
- username 字符串（可选）
- password 字符串（可选）

当 webContents 想进行基本身份验证时发出。

默认行为是取消所有身份验证。要覆盖此行为，你应该使用 event.preventDefault() 来阻止默认行为并使用凭据调用 callback(username, password)。

const { app } = require('electron')

app.on('login', (event, webContents, details, authInfo, callback) => {
  event.preventDefault()
  callback('username', 'secret')
})

如果在没有用户名或密码的情况下调用 callback，则身份验证请求将被取消，并且身份验证错误将返回到页面。

事件：'gpu-info-update'

每当有 GPU 信息更新时发出。

事件：'render-process-gone'

event 事件
webContents WebContents
details RenderProcessGoneDetails

当渲染器进程意外消失时发出。这通常是因为它崩溃或被杀死。

事件：'child-process-gone'

event 事件
details 对象
- type 字符串 - 进程类型。以下值之一
  - 实用工具
  - Zygote
  - 沙箱助手
  - GPU
  - Pepper 插件
  - Pepper 插件代理
  - 未知
- reason 字符串 - 子进程消失的原因。可能的值
  - clean-exit - 进程退出时的退出代码为零
  - abnormal-exit - 进程退出时的退出代码不为零
  - killed - 进程被发送了 SIGTERM 或以其他方式在外部被杀死
  - crashed - 进程崩溃
  - oom - 进程内存不足
  - launch-failed - 进程从未成功启动
  - integrity-failure - Windows 代码完整性检查失败
- exitCode 数字 - 进程的退出代码（例如，如果在 posix 上，则为 waitpid 的状态，如果在 Windows 上，则为 GetExitCodeProcess 的状态）。
- serviceName 字符串（可选） - 进程的非本地化名称。
- name 字符串（可选） - 进程的名称。实用工具的示例：音频服务、内容解密模块服务、网络服务、视频捕获等。

当子进程意外消失时发出。这通常是因为它崩溃或被杀死。不包括渲染器进程。

事件：'accessibility-support-changed' macOS Windows

event 事件
accessibilitySupportEnabled 布尔值 - 当 Chrome 的辅助功能支持已启用时为 true，否则为 false。

当 Chrome 的辅助功能支持发生更改时发出。当启用或禁用辅助技术（例如屏幕阅读器）时，会触发此事件。有关更多详细信息，请参阅 https://www.chromium.org/developers/design-documents/accessibility。

事件：'session-created'

session 会话

当 Electron 创建新的 会话时发出。

const { app } = require('electron')

app.on('session-created', (session) => {
  console.log(session)
})

事件：'second-instance'

event 事件
argv 字符串[] - 第二个实例的命令行参数数组
workingDirectory 字符串 - 第二个实例的工作目录
additionalData unknown - 从第二个实例传递的附加数据 JSON 对象

当执行第二个实例并调用 app.requestSingleInstanceLock() 时，此事件将在应用程序的主实例中触发。

argv 是第二个实例的命令行参数数组，workingDirectory 是其当前工作目录。通常，应用程序会通过使主窗口获得焦点且不最小化来响应此事件。

注意：argv 不会与传递给第二个实例的参数列表完全相同。顺序可能会更改，并且可能会追加其他参数。如果您需要保留完全相同参数，建议改用 additionalData。

注意：如果第二个实例是由与第一个实例不同的用户启动的，则 argv 数组将不包含参数。

此事件保证在 app 的 ready 事件触发后触发。

注意：Chromium 可能会添加额外的命令行参数，例如 --original-process-start-time。

方法

app 对象具有以下方法

注意：某些方法仅在特定操作系统上可用，并被标记为该操作系统。

`app.quit()`

尝试关闭所有窗口。首先会触发 before-quit 事件。如果所有窗口都已成功关闭，则会触发 will-quit 事件，并且默认情况下应用程序将终止。

此方法确保正确执行所有 beforeunload 和 unload 事件处理程序。窗口有可能在 beforeunload 事件处理程序中返回 false 来取消退出。

`app.exit([exitCode])`

exitCode 整数（可选）

立即退出，退出代码为 exitCode。exitCode 默认为 0。

所有窗口都将立即关闭，而无需询问用户，并且不会触发 before-quit 和 will-quit 事件。

`app.relaunch([options])`

options 对象（可选）
- args 字符串数组（可选）
- execPath 字符串（可选）

当前实例退出时重新启动应用程序。

默认情况下，新实例将使用与当前实例相同的当前工作目录和命令行参数。当指定 args 时，args 将作为命令行参数传递。当指定 execPath 时，将执行 execPath 以重新启动，而不是当前应用程序。

请注意，此方法在执行时不会退出应用程序，您必须在调用 app.relaunch 后调用 app.quit 或 app.exit 以使应用程序重新启动。

当多次调用 app.relaunch 时，在当前实例退出后将启动多个实例。

立即重新启动当前实例并向新实例添加新命令行参数的示例

const { app } = require('electron')

app.relaunch({ args: process.argv.slice(1).concat(['--relaunch']) })
app.exit(0)

`app.isReady()`

返回 boolean - true（如果 Electron 已完成初始化），否则为 false。另请参阅 app.whenReady()。

`app.whenReady()`

返回 Promise<void> - 在 Electron 初始化时实现。如果应用程序尚未准备好，可以使用此方法作为检查 app.isReady() 和订阅 ready 事件的便捷替代方法。

`app.focus([options])`

options 对象（可选）
- steal 布尔值 macOS - 即使当前有其他应用程序处于活动状态，也使接收者成为活动应用程序。

在 Linux 上，聚焦于第一个可见窗口。在 macOS 上，使应用程序成为活动应用程序。在 Windows 上，聚焦于应用程序的第一个窗口。

您应尽可能少地使用 steal 选项。

`app.hide()` macOS

隐藏所有应用程序窗口，而不最小化它们。

`app.isHidden()` macOS

返回 boolean - true（如果应用程序（包括其所有窗口）处于隐藏状态（例如通过 Command-H），否则为 false。

`app.show()` macOS

隐藏后显示应用程序窗口。不会自动聚焦它们。

`app.setAppLogsPath([path])`

path 字符串（可选） - 日志的自定义路径。必须是绝对路径。

设置或创建应用程序日志目录，然后可以使用 app.getPath() 或 app.setPath(pathName, newPath) 对其进行操作。

在没有 path 参数的情况下调用 app.setAppLogsPath() 将导致在 macOS 上将此目录设置为 ~/Library/Logs/YourAppName，在 Linux 和 Windows 上设置为 userData 目录内。

`app.getAppPath()`

返回 string - 当前应用程序目录。

`app.getPath(name)`

name 字符串 - 您可以按名称请求以下路径
- home 用户的主目录。
- appData 每个用户的应用程序数据目录，默认指向
  - Windows 上的 %APPDATA%
  - Linux 上的 $XDG_CONFIG_HOME 或 ~/.config
  - macOS 上的 ~/Library/Application Support
- userData 用于存储应用程序配置文件的目录，默认情况下是 appData 目录，后面附加了应用程序的名称。根据惯例，存储用户数据的文件应写入此目录，不建议在此处写入大文件，因为某些环境可能会将此目录备份到云存储。
- sessionData 存储由 Session 生成的数据的目录，例如 localStorage、cookie、磁盘缓存、下载的字典、网络状态、devtools 文件。默认情况下，它指向 userData。Chromium 可能在此处写入非常大的磁盘缓存，因此，如果您的应用不依赖于浏览器存储（如 localStorage 或 cookie）来保存用户数据，建议将此目录设置为其他位置，以避免污染 userData 目录。
- temp 临时目录。
- exe 当前可执行文件。
- module libchromiumcontent 库。
- desktop 当前用户的桌面目录。
- documents 用户的“我的文档”目录。
- downloads 用户的下载目录。
- music 用户的音乐目录。
- pictures 用户的图片目录。
- videos 用户的视频目录。
- recent 用户的最近文件目录（仅限 Windows）。
- logs 您的应用日志文件夹的目录。
- crashDumps 存储崩溃转储的目录。

返回 string - 与 name 关联的特殊目录或文件的路径。如果失败，将抛出 Error。

如果在未首先调用 app.setAppLogsPath() 的情况下调用 app.getPath('logs')，则将创建一个默认日志目录，等同于在没有 path 参数的情况下调用 app.setAppLogsPath()。

`app.getFileIcon(path[, options])`

path 字符串
options 对象（可选）
- size 字符串
  - small - 16x16
  - normal - 32x32
  - large - 48x48（在 Linux 中），32x32（在 Windows 中），在 macOS 中不受支持。

返回 Promise<NativeImage> - 使用应用图标（它是 NativeImage）实现。

获取路径的关联图标。

在 Windows 中，有 2 种图标

与某些文件扩展名（如 .mp3、.png 等）关联的图标。
文件本身内的图标，如 .exe、.dll、.ico。

在 Linux 和 macOS 中，图标取决于与文件 MIME 类型关联的应用程序。

`app.setPath(name, path)`

name 字符串
path 字符串

覆盖与 name 关联的特殊目录或文件的 path。如果路径指定不存在的目录，则会抛出 Error。在这种情况下，应使用 fs.mkdirSync 或类似方法创建目录。

您只能覆盖在 app.getPath 中定义的 name 的路径。

默认情况下，网页的 cookie 和缓存将存储在 sessionData 目录下。如果您想更改此位置，则必须在发出 app 模块的 ready 事件之前覆盖 sessionData 路径。

`app.getVersion()`

返回 string - 已加载应用程序的版本。如果在应用程序的 package.json 文件中找不到版本，则返回当前包或可执行文件的版本。

`app.getName()`

返回 string - 当前应用程序的名称，即应用程序 package.json 文件中的名称。

通常，根据 npm 模块规范，package.json 的 name 字段是一个短小写名称。您通常还应该指定一个 productName 字段，该字段是应用程序的完整大写名称，Electron 会优先于 name 使用该字段。

`app.setName(name)`

name 字符串

覆盖当前应用程序的名称。

注意：此函数覆盖 Electron 内部使用的名称；它不影响操作系统使用的名称。

`app.getLocale()`

返回 string - 当前应用程序语言环境，使用 Chromium 的 l10n_util 库获取。可能的返回值在此处记录此处。

要设置语言环境，您需要在应用程序启动时使用命令行开关，可以在此处找到。

注意：在分发打包的应用程序时，您还必须发送 locales 文件夹。

注意：此 API 必须在发出 ready 事件后调用。

注意：要查看此 API 与其他语言环境和语言 API 的示例返回值的比较，请参阅app.getPreferredSystemLanguages()。

`app.getLocaleCountryCode()`

返回 string - 用户操作系统语言环境的两位ISO 3166国家/地区代码。该值取自本机操作系统 API。

注意：无法检测到语言环境国家/地区代码时，它返回空字符串。

`app.getSystemLocale()`

返回 string - 当前系统语言环境。在 Windows 和 Linux 上，它使用 Chromium 的 i18n 库获取。在 macOS 上，则使用 [NSLocale currentLocale]。要获取用户的当前系统语言（不总是与语言环境相同），最好使用app.getPreferredSystemLanguages()。

不同的操作系统也以不同的方式使用区域数据

Windows 11 使用区域格式来表示数字、日期和时间。
macOS Monterey 使用区域来设置数字、日期、时间格式，以及选择要使用的货币符号。

因此，此 API 可用于选择日历应用中日期和时间呈现格式等目的，尤其是在开发者希望格式与操作系统保持一致时。

注意：此 API 必须在发出 ready 事件后调用。

注意：要查看此 API 与其他语言环境和语言 API 的示例返回值的比较，请参阅app.getPreferredSystemLanguages()。

`app.getPreferredSystemLanguages()`

返回 string[] - 用户首选系统语言，从最首选到最不首选，包括适用的国家/地区代码。用户可以通过 Windows 或 macOS 中的“语言和区域”设置修改此列表并向其中添加内容。

此 API 在 Windows 上使用 GlobalizationPreferences（回退到 GetSystemPreferredUILanguages），在 macOS 上使用 \[NSLocale preferredLanguages\]，在 Linux 上使用 g_get_language_names。

此 API 可用于决定以何种语言呈现应用程序等目的。

以下是各种语言和区域设置 API 在不同配置下的返回值示例

在 Windows 上，给定应用程序区域设置为德语，区域格式为芬兰语（芬兰），首选系统语言从最首选到最不首选依次为法语（加拿大）、英语（美国）、简体中文（中国）、芬兰语和西班牙语（拉丁美洲）

app.getLocale() // 'de'
app.getSystemLocale() // 'fi-FI'
app.getPreferredSystemLanguages() // ['fr-CA', 'en-US', 'zh-Hans-CN', 'fi', 'es-419']

在 macOS 上，给定应用程序区域设置为德语，区域为芬兰，首选系统语言从最首选到最不首选依次为法语（加拿大）、英语（美国）、简体中文和西班牙语（拉丁美洲）

app.getLocale() // 'de'
app.getSystemLocale() // 'fr-FI'
app.getPreferredSystemLanguages() // ['fr-CA', 'en-US', 'zh-Hans-FI', 'es-419']

两种操作系统中可用的语言和区域以及可能的返回值都不同。

如上例所示，在 Windows 上，首选系统语言可能没有国家/地区代码，并且首选系统语言之一可能与区域格式使用的语言相对应。在 macOS 上，区域更多地用作默认国家/地区代码：用户不必将芬兰语作为首选语言即可将芬兰用作区域，并且国家/地区代码 FI 用作语言名称中没有关联国家/地区的首选系统语言的国家/地区代码。

`app.addRecentDocument(path)` macOS Windows

path 字符串

将 path 添加到最近文档列表中。

此列表由操作系统管理。在 Windows 上，你可以从任务栏访问列表，在 macOS 上，你可以从 Dock 菜单访问列表。

`app.clearRecentDocuments()` macOS Windows

清除最近文档列表。

`app.setAsDefaultProtocolClient(protocol[, path, args])`

protocol 字符串 - 你的协议的名称，不含 ://。例如，如果你想让你的应用处理 electron:// 链接，请使用 electron 作为参数调用此方法。
path 字符串（可选） Windows - Electron 可执行文件的路径。默认为 process.execPath
args 字符串数组（可选） Windows - 传递给可执行文件参数。默认为一个空数组

返回 boolean - 调用是否成功。

将当前可执行文件设置为协议（又称 URI 方案）的默认处理程序。它允许你将你的应用更深入地集成到操作系统中。注册后，所有带有 your-protocol:// 的链接都将使用当前可执行文件打开。整个链接，包括协议，将作为参数传递给你的应用程序。

注意：在 macOS 上，你只能注册已添加到你的应用的 info.plist 中的协议，而该协议在运行时无法修改。但是，你可以通过 Electron Forge、Electron Packager 或使用文本编辑器编辑 info.plist 来在构建时更改文件。请参阅 Apple 文档了解详情。

注意：在 Windows 应用商店环境（以 appx 打包时），此 API 将对所有调用返回 true，但它设置的注册表项将无法被其他应用程序访问。为了将 Windows 应用商店应用程序注册为默认协议处理程序，您必须在清单中声明协议。

此 API 在内部使用 Windows 注册表和 LSSetDefaultHandlerForURLScheme。

`app.removeAsDefaultProtocolClient(protocol[, path, args])` macOS Windows

protocol 字符串 - 您的协议的名称，不带 ://。
path 字符串（可选） Windows - 默认为 process.execPath
args string[]（可选） Windows - 默认为一个空数组

返回 boolean - 调用是否成功。

此方法检查当前可执行文件是否为协议（又称 URI 方案）的默认处理程序。如果是，它将删除该应用程序作为默认处理程序。

`app.isDefaultProtocolClient(protocol[, path, args])`

protocol 字符串 - 您的协议的名称，不带 ://。
path 字符串（可选） Windows - 默认为 process.execPath
args string[]（可选） Windows - 默认为一个空数组

返回 boolean - 当前可执行文件是否是协议（又称 URI 方案）的默认处理程序。

注意：在 macOS 上，您可以使用此方法检查该应用程序是否已注册为协议的默认协议处理程序。您还可以通过检查 macOS 机器上的 ~/Library/Preferences/com.apple.LaunchServices.plist 来验证这一点。有关详细信息，请参阅Apple 的文档。

此 API 在内部使用 Windows 注册表和 LSCopyDefaultHandlerForURLScheme。

`app.getApplicationNameForProtocol(url)`

url 字符串 - 带有要检查的协议名称的 URL。与本系列中的其他方法不同，此方法接受整个 URL，至少包括 ://（例如 https://）。

返回 string - 处理该协议的应用程序的名称，如果没有处理程序，则返回一个空字符串。例如，如果 Electron 是 URL 的默认处理程序，则这在 Windows 和 Mac 上可能是 Electron。但是，不要依赖于精确的格式，因为不能保证它保持不变。在 Linux 上，可能会有不同的格式，可能带有 .desktop 后缀。

此方法返回 URL 的协议（又称 URI 方案）的默认处理程序的应用程序名称。

`app.getApplicationInfoForProtocol(url)` macOS Windows

url 字符串 - 带有要检查的协议名称的 URL。与本系列中的其他方法不同，此方法接受整个 URL，至少包括 ://（例如 https://）。

返回 Promise<Object> - 使用包含以下内容的对象解析

icon NativeImage - 处理协议的应用程序的显示图标。
path 字符串 - 处理协议的应用程序的安装路径。
name 字符串 - 处理协议的应用程序的显示名称。

此方法返回一个包含应用程序名称、图标和 URL 协议（也称为 URI 方案）的默认处理程序的路径的 Promise。

`app.setUserTasks(tasks)` Windows

tasks Task[] - Task 对象数组

将 tasks 添加到 Windows 上跳转列表的任务类别。

tasks 是 Task 对象的数组。

返回 boolean - 调用是否成功。

注意：如果您希望进一步自定义跳转列表，请改用 app.setJumpList(categories)。

`app.getJumpListSettings()` Windows

返回 Object

minItems 整数 - 跳转列表中显示的最小项目数（有关此值的更详细说明，请参阅 MSDN 文档）。
removedItems JumpListItem[] - 对应于用户从 Jump List 中自定义类别中明确删除的项的 JumpListItem 对象数组。在对 app.setJumpList() 的下一次调用中，这些项不得重新添加到 Jump List 中，Windows 不会显示包含任何已删除项的任何自定义类别。

`app.setJumpList(categories)` Windows

categories JumpListCategory[] | null - JumpListCategory 对象数组。

返回 string

设置或删除应用程序的自定义 Jump List，并返回以下字符串之一

ok - 未出现任何问题。
error - 出现了一个或多个错误，启用运行时日志记录以找出可能的原因。
invalidSeparatorError - 尝试向 Jump List 中的自定义类别添加分隔符。分隔符仅允许在标准 Tasks 类别中。
fileTypeRegistrationError - 尝试向 Jump List 中添加应用程序未注册为处理的文件类型的文件链接。
customCategoryAccessDeniedError - 由于用户隐私或组策略设置，无法将自定义类别添加到 Jump List 中。

如果 categories 为 null，则先前设置的自定义 Jump List（如果存在）将被应用程序的标准 Jump List（由 Windows 管理）替换。

注意：如果 JumpListCategory 对象未设置 type 或 name 属性，则其 type 假定为 tasks。如果设置了 name 属性但省略了 type 属性，则假定 type 为 custom。

注意：用户可以从自定义类别中删除项，并且在对 app.setJumpList(categories) 的下一次成功调用之后，Windows 才会允许将已删除的项重新添加到自定义类别中。早于此尝试将已删除的项重新添加到自定义类别中，将导致整个自定义类别从 Jump List 中被省略。可以使用 app.getJumpListSettings() 获取已删除项的列表。

注意：Jump List 项目的 description 属性的最大长度为 260 个字符。超过此限制，项目将不会添加到 Jump List 中，也不会显示。

以下是创建自定义 Jump List 的一个非常简单的示例

const { app } = require('electron')

app.setJumpList([
  {
    type: 'custom',
    name: 'Recent Projects',
    items: [
      { type: 'file', path: 'C:\\Projects\\project1.proj' },
      { type: 'file', path: 'C:\\Projects\\project2.proj' }
    ]
  },
  { // has a name so `type` is assumed to be "custom"
    name: 'Tools',
    items: [
      {
        type: 'task',
        title: 'Tool A',
        program: process.execPath,
        args: '--run-tool-a',
        iconPath: process.execPath,
        iconIndex: 0,
        description: 'Runs Tool A'
      },
      {
        type: 'task',
        title: 'Tool B',
        program: process.execPath,
        args: '--run-tool-b',
        iconPath: process.execPath,
        iconIndex: 0,
        description: 'Runs Tool B'
      }
    ]
  },
  { type: 'frequent' },
  { // has no name and no type so `type` is assumed to be "tasks"
    items: [
      {
        type: 'task',
        title: 'New Project',
        program: process.execPath,
        args: '--new-project',
        description: 'Create a new project.'
      },
      { type: 'separator' },
      {
        type: 'task',
        title: 'Recover Project',
        program: process.execPath,
        args: '--recover-project',
        description: 'Recover Project'
      }
    ]
  }
])

`app.requestSingleInstanceLock([additionalData])`

additionalData Record<any, any>（可选） - 包含要发送到第一个实例的附加数据的 JSON 对象。

返回 boolean

此方法的返回值指示您的应用程序的此实例是否成功获取了锁。如果获取锁失败，您可以假设您的应用程序的另一个实例已使用该锁运行，并立即退出。

即，如果您的进程是应用程序的主实例，并且您的应用程序应继续加载，则此方法返回 true。如果您的进程应立即退出，因为它已将其参数发送到已获取锁的另一个实例，则它返回 false。

在 macOS 上，当用户尝试在 Finder 中打开应用程序的第二个实例时，系统会自动强制执行单实例，并且会为此发出 open-file 和 open-url 事件。但是，当用户在命令行中启动您的应用程序时，系统的单实例机制将被绕过，您必须使用此方法来确保单实例。

当第二个实例启动时激活主实例窗口的示例

const { app, BrowserWindow } = require('electron')
let myWindow = null

const additionalData = { myKey: 'myValue' }
const gotTheLock = app.requestSingleInstanceLock(additionalData)

if (!gotTheLock) {
  app.quit()
} else {
  app.on('second-instance', (event, commandLine, workingDirectory, additionalData) => {
    // Print out data received from the second instance.
    console.log(additionalData)

    // Someone tried to run a second instance, we should focus our window.
    if (myWindow) {
      if (myWindow.isMinimized()) myWindow.restore()
      myWindow.focus()
    }
  })

  app.whenReady().then(() => {
    myWindow = new BrowserWindow({})
    myWindow.loadURL('https://electron.js.cn')
  })
}

`app.hasSingleInstanceLock()`

返回 boolean

此方法返回您的应用程序的此实例当前是否持有单实例锁。您可以使用 app.requestSingleInstanceLock() 请求锁，并使用 app.releaseSingleInstanceLock() 释放锁

`app.releaseSingleInstanceLock()`

释放由 requestSingleInstanceLock 创建的所有锁。这将允许应用程序的多个实例再次并排运行。

`app.setUserActivity(type, userInfo[, webpageURL])` macOS

type 字符串 - 唯一标识活动。映射到 NSUserActivity.activityType。
userInfo any - 要存储以供其他设备使用的应用程序特定状态。
webpageURL 字符串（可选） - 如果恢复设备上未安装合适的应用，则在浏览器中加载的网页。该方案必须是 http 或 https。

创建 NSUserActivity 并将其设置为当前活动。该活动有资格在之后传递到另一设备。

`app.getCurrentActivityType()` macOS

返回 string - 当前运行活动的类型。

`app.invalidateCurrentActivity()` macOS

使当前传递用户活动无效。

`app.resignCurrentActivity()` macOS

将当前传递用户活动标记为不活动，而不会使其无效。

`app.updateCurrentActivity(type, userInfo)` macOS

type 字符串 - 唯一标识活动。映射到 NSUserActivity.activityType。
userInfo any - 要存储以供其他设备使用的应用程序特定状态。

如果其类型与 type 匹配，则更新当前活动，将 userInfo 中的条目合并到其当前 userInfo 字典中。

`app.setAppUserModelId(id)` Windows

id 字符串

将应用程序用户模型 ID 更改为 id。

`app.setActivationPolicy(policy)` macOS

policy 字符串 - 可以是“regular”、“accessory”或“prohibited”。

设置给定应用的激活策略。

激活策略类型

'regular' - 该应用程序是一个普通应用，它会显示在 Dock 中，并且可能具有用户界面。
“辅助” - 该应用程序不会显示在 Dock 中，也没有菜单栏，但可以通过编程或单击其某个窗口来激活它。
“禁止” - 该应用程序不会显示在 Dock 中，也不能创建窗口或被激活。

`app.importCertificate(options, callback)` Linux

options 对象
- certificate 字符串 - pkcs12 文件的路径。
- password 字符串 - 证书的密码。
callback 函数
- result 整数 - 导入结果。

将 pkcs12 格式的证书导入平台证书存储。callback 使用导入操作的 result 调用，值为 0 表示成功，而任何其他值都表示失败，具体取决于 Chromium net_error_list。

`app.configureHostResolver(options)`

options 对象
- enableBuiltInResolver 布尔值（可选） - 是否优先于 getaddrinfo 使用内置主机解析器。启用后，内置解析器将尝试使用系统的 DNS 设置自行进行 DNS 查找。在 macOS 上默认启用，在 Windows 和 Linux 上默认禁用。
- secureDnsMode 字符串（可选） - 可以是“off”、“automatic”或“secure”。配置 DNS-over-HTTP 模式。当为“off”时，不会执行 DoH 查找。当为“automatic”时，如果 DoH 可用，将首先执行 DoH 查找，并将执行不安全的 DNS 查找作为后备。当为“secure”时，只会执行 DoH 查找。默认为“automatic”。
- secureDnsServers 字符串数组（可选） - DNS-over-HTTP 服务器模板列表。有关模板格式的详细信息，请参见 RFC8484 § 3。大多数服务器都支持 POST 方法；此类服务器的模板只是一个 URI。请注意，对于一些 DNS 提供商，除非明确禁用 DoH，否则解析器将自动升级到 DoH，即使此列表中没有提供 DoH 服务器也是如此。
- enableAdditionalDnsQueryTypes 布尔值（可选） - 控制是否允许在通过不安全的 DNS 进行请求时除了传统的 A 和 AAAA 查询之外的其他 DNS 查询类型，例如 HTTPS（DNS 类型 65）。对始终允许其他类型的安全 DNS 没有影响。默认为 true。

配置主机解析（DNS 和 DNS-over-HTTPS）。默认情况下，将按以下顺序使用下列解析器

如果 DNS 提供商支持 DNS-over-HTTPS，则使用 DNS-over-HTTPS，然后
内置解析器（默认情况下仅在 macOS 上启用），然后
系统解析器（例如 getaddrinfo）。

可以将其配置为限制使用未加密的 DNS（secureDnsMode: "secure"）或禁用 DNS-over-HTTPS（secureDnsMode: "off"）。还可以启用或禁用内置解析器。

要禁用不安全的 DNS，可以指定 secureDnsMode 为 "secure"。如果这样做，你应确保提供要使用的 DNS-over-HTTPS 服务器列表，以防用户 DNS 配置中不包括支持 DoH 的提供商。

const { app } = require('electron')

app.whenReady().then(() => {
  app.configureHostResolver({
    secureDnsMode: 'secure',
    secureDnsServers: [
      'https://cloudflare-dns.com/dns-query'
    ]
  })
})

必须在发出 ready 事件后调用此 API。

`app.disableHardwareAcceleration()`

禁用当前应用的硬件加速。

此方法只能在应用准备就绪之前调用。

`app.disableDomainBlockingFor3DAPIs()`

默认情况下，如果 GPU 进程崩溃得太频繁，Chromium 会按每个域禁用 3D API（例如 WebGL），直到重新启动。此功能会禁用该行为。

此方法只能在应用准备就绪之前调用。

`app.getAppMetrics()`

返回 ProcessMetric[]：与应用关联的所有进程的内存和 CPU 使用情况统计信息对应的 ProcessMetric 对象数组。

`app.getGPUFeatureStatus()`

返回 GPUFeatureStatus - chrome://gpu/ 中的图形功能状态。

注意：此信息仅在发出 gpu-info-update 事件后才可用。

`app.getGPUInfo(infoType)`

infoType 字符串 - 可以是 basic 或 complete。

返回 Promise<unknown>

对于等于 complete 的 infoType：Promise 使用包含所有 GPU 信息的 Object 兑现，如 Chromium 的 GPUInfo 对象中所示。这包括 chrome://gpu 页面上显示的版本和驱动程序信息。

对于等于 basic 的 infoType：Promise 使用包含比使用 complete 请求时更少属性的 Object 兑现。以下是基本响应示例

{
  auxAttributes:
   {
     amdSwitchable: true,
     canSupportThreadedTextureMailbox: false,
     directComposition: false,
     directRendering: true,
     glResetNotificationStrategy: 0,
     inProcessGpu: true,
     initializationTime: 0,
     jpegDecodeAcceleratorSupported: false,
     optimus: false,
     passthroughCmdDecoder: false,
     sandboxed: false,
     softwareRendering: false,
     supportsOverlays: false,
     videoDecodeAcceleratorFlags: 0
   },
  gpuDevice:
   [{ active: true, deviceId: 26657, vendorId: 4098 },
     { active: false, deviceId: 3366, vendorId: 32902 }],
  machineModelName: 'MacBookPro',
  machineModelVersion: '11.5'
}

如果只需要基本信息，如 vendorId 或 deviceId，则应优先使用 basic。

`app.setBadgeCount([count])` Linux macOS

count 整数（可选）- 如果提供值，则将徽章设置为提供的值，否则在 macOS 上，显示一个纯白色圆点（例如，未知数量的通知）。在 Linux 上，如果未提供值，则徽章将不显示。

返回 boolean - 调用是否成功。

设置当前应用程序的计数器徽章。将计数设置为 0 将隐藏徽章。

在 macOS 上，它显示在 Dock 图标上。在 Linux 上，它仅适用于 Unity 启动器。

注意：Unity 启动器需要一个 .desktop 文件才能工作。有关更多信息，请阅读 Unity 集成文档。

注意：在 macOS 上，您需要确保您的应用程序有权显示通知，此方法才能工作。

`app.getBadgeCount()` Linux macOS

返回 整数 - 计数器徽章中显示的当前值。

`app.isUnityRunning()` Linux

返回 布尔值 - 当前桌面环境是否是 Unity 启动器。

`app.getLoginItemSettings([options])` macOS Windows

options 对象（可选）
- type 字符串（可选）macOS - 可以是 mainAppService、agentService、daemonService 或 loginItemService 之一。默认为 mainAppService。仅在 macOS 13 及更高版本中可用。有关每种类型的详细信息，请参阅 app.setLoginItemSettings。
- serviceName 字符串（可选）macOS - 服务名称。如果 type 为非默认值，则必需。仅适用于 macOS 13 及更高版本。
- path 字符串（可选）Windows - 要比较的可执行文件路径。默认为 process.execPath。
- args 字符串[]（可选）Windows - 要比较的命令行参数。默认为空数组。

如果您向 app.setLoginItemSettings 提供了 path 和 args 选项，那么您需要在此处传递相同的参数，才能正确设置 openAtLogin。

返回 Object

openAtLogin 布尔值 - 如果应用程序设置为开机启动，则为 true。
openAsHidden 布尔值 macOS 已弃用 - 如果应用程序设置为开机时隐藏启动，则为 true。这在 macOS 13 及更高版本中不起作用。
wasOpenedAtLogin 布尔值 macOS 已弃用 - 如果应用程序自动在开机时打开，则为 true。此设置在 MAS 构建或 macOS 13 及更高版本中不可用。
wasOpenedAsHidden 布尔值 macOS 已弃用 - 如果应用程序作为隐藏登录项打开，则为 true。这表明应用程序在启动时不应打开任何窗口。此设置在 MAS 构建或 macOS 13 及更高版本中不可用。
restoreState 布尔值 macOS 已弃用 - 如果应用程序作为登录项打开，并且应该从上一个会话中恢复状态，则为 true。这表明应用程序应恢复上次关闭应用程序时打开的窗口。此设置在 MAS 构建或 macOS 13 及更高版本中不可用。
status 字符串 macOS - 可以是 not-registered、enabled、requires-approval 或 not-found 之一。
executableWillLaunchAtLogin 布尔值 Windows - 如果应用程序设置为开机启动且其运行键未停用，则为 true。这与 openAtLogin 不同，因为它忽略了 args 选项，如果给定的可执行文件在登录时使用任何参数启动，则此属性将为 true。
launchItems 对象[] Windows
- name 字符串 Windows - 注册表项的名称值。
- path 字符串 Windows - 对应于注册表项的应用程序的可执行文件。
- args 字符串[] Windows - 传递给可执行文件的命令行参数。
- scope 字符串 Windows - user 或 machine 之一。指示注册表项位于 HKEY_CURRENT USER 还是 HKEY_LOCAL_MACHINE 下。
- enabled 布尔值 Windows - 如果应用程序注册表项已启动批准，因此在任务管理器和 Windows 设置中显示为 enabled，则为 true。

`app.setLoginItemSettings(settings)` macOS Windows

settings 对象
- openAtLogin 布尔值（可选） - true 表示登录时打开应用程序，false 表示将应用程序移除为登录项。默认为 false。
- openAsHidden 布尔值（可选） macOS 已弃用 - true 表示以隐藏方式打开应用程序。默认为 false。用户可以从系统偏好设置中编辑此设置，因此当应用程序打开时应检查 app.getLoginItemSettings().wasOpenedAsHidden 以了解当前值。此设置在 MAS 构建或 macOS 13 及更高版本上不可用。
- type 字符串（可选） macOS - 要作为登录项添加的服务类型。默认为 mainAppService。仅在 macOS 13 及更高版本上可用。
  - mainAppService - 主要应用程序。
  - agentService - 启动代理的属性列表名称。属性列表名称必须对应于应用程序 Contents/Library/LaunchAgents 目录中的属性列表。
  - daemonService 字符串（可选） macOS - 启动代理的属性列表名称。属性列表名称必须对应于应用程序 Contents/Library/LaunchDaemons 目录中的属性列表。
  - loginItemService 字符串（可选） macOS - 登录项服务的属性列表名称。属性列表名称必须对应于应用程序 Contents/Library/LoginItems 目录中的属性列表。
- serviceName 字符串（可选）macOS - 服务名称。如果 type 为非默认值，则必需。仅适用于 macOS 13 及更高版本。
- path 字符串（可选） Windows - 登录时启动的可执行文件。默认为 process.execPath。
- args 字符串数组（可选） Windows - 传递给可执行文件的命令行参数。默认为一个空数组。注意用引号将路径括起来。
- enabled 布尔值（可选） Windows - true 将更改启动批准的注册表项，并在任务管理器和 Windows 设置中启用/禁用应用程序。默认为 true。
- name 字符串（可选） Windows - 要写入注册表的值名称。默认为应用程序的 AppUserModelId()。

设置应用程序的登录项设置。

要在 Windows 上使用 Electron 的 autoUpdater（它使用 Squirrel），您需要将启动路径设置为 Update.exe，并传递指定应用程序名称的参数。例如

const { app } = require('electron')
const path = require('node:path')

const appFolder = path.dirname(process.execPath)
const updateExe = path.resolve(appFolder, '..', 'Update.exe')
const exeName = path.basename(process.execPath)

app.setLoginItemSettings({
  openAtLogin: true,
  path: updateExe,
  args: [
    '--processStart', `"${exeName}"`,
    '--process-start-args', '"--hidden"'
  ]
})

有关在 macOS 13 及更高版本上将不同服务设置为登录项的更多信息，请参阅 SMAppService。

`app.isAccessibilitySupportEnabled()` macOS Windows

返回 布尔值 - 如果启用了 Chrome 的辅助功能支持，则为 true，否则为 false。如果检测到辅助技术（例如屏幕阅读器）的使用，此 API 将返回 true。有关更多详细信息，请参阅 https://www.chromium.org/developers/design-documents/accessibility。

`app.setAccessibilitySupportEnabled(enabled)` macOS Windows

enabled 布尔值 - 启用或禁用辅助功能树渲染

手动启用 Chrome 的辅助功能支持，允许在应用程序设置中向用户公开辅助功能开关。有关更多详细信息，请参阅 Chromium 的辅助功能文档。默认情况下禁用。

必须在发出 ready 事件后调用此 API。

注意：渲染辅助功能树会显著影响应用程序的性能。它不应该默认启用。

`app.showAboutPanel()`

显示应用程序的关于面板选项。这些选项可以通过 app.setAboutPanelOptions(options) 覆盖。此函数异步运行。

`app.setAboutPanelOptions(options)`

options 对象
- applicationName 字符串（可选） - 应用程序的名称。
- applicationVersion 字符串（可选） - 应用程序的版本。
- copyright 字符串（可选） - 版权信息。
- version 字符串（可选） macOS - 应用的构建版本号。
- credits 字符串（可选） macOS Windows - 鸣谢信息。
- authors 字符串[]（可选） Linux - 应用作者列表。
- website 字符串（可选） Linux - 应用的网站。
- iconPath 字符串（可选） Linux Windows - 应用图标的路径，采用 JPEG 或 PNG 文件格式。在 Linux 上，将以 64x64 像素显示，同时保持纵横比。

设置关于面板选项。这将覆盖 macOS 上应用的 .plist 文件中定义的值。有关更多详细信息，请参阅 Apple 文档。在 Linux 上，必须设置值才能显示；没有默认值。

如果您没有设置 credits 但仍希望在应用中显示它们，AppKit 将按此顺序在 NSBundle 类方法 main 返回的包中查找名为“Credits.html”、“Credits.rtf”和“Credits.rtfd”的文件。使用找到的第一个文件，如果找不到，则信息区域将留空。有关更多信息，请参阅 Apple 文档。

`app.isEmojiPanelSupported()`

返回 boolean - 当前操作系统版本是否允许使用原生表情符号选择器。

`app.showEmojiPanel()` macOS Windows

显示平台的原生表情符号选择器。

`app.startAccessingSecurityScopedResource(bookmarkData)` MAS

bookmarkData 字符串 - 由 dialog.showOpenDialog 或 dialog.showSaveDialog 方法返回的 base64 编码的安全范围书签数据。

返回 Function - 必须在完成对安全范围文件访问后调用此函数。如果您忘记停止访问书签，则内核资源将泄漏，并且您的应用程序将完全失去访问沙盒外部的能力，直到应用程序重新启动。

const { app, dialog } = require('electron')
const fs = require('node:fs')

let filepath
let bookmark

dialog.showOpenDialog(null, { securityScopedBookmarks: true }).then(({ filePaths, bookmarks }) => {
  filepath = filePaths[0]
  bookmark = bookmarks[0]
  fs.readFileSync(filepath)
})

// ... restart app ...

const stopAccessingSecurityScopedResource = app.startAccessingSecurityScopedResource(bookmark)
fs.readFileSync(filepath)
stopAccessingSecurityScopedResource()

开始访问安全范围资源。使用此方法，为 Mac App Store 打包的 Electron 应用程序可以访问沙盒外部，以访问用户选择的文件。有关此系统工作原理的说明，请参阅 Apple 的文档。

`app.enableSandbox()`

在应用程序上启用完全沙盒模式。这意味着所有渲染器都将以沙盒模式启动，而不管 WebPreferences 中 sandbox 标志的值如何。

此方法只能在应用准备就绪之前调用。

`app.isInApplicationsFolder()` macOS

返回 boolean - 应用程序当前是否正在从系统的应用程序文件夹中运行。与 app.moveToApplicationsFolder() 结合使用

`app.moveToApplicationsFolder([options])` macOS

options 对象（可选）
- conflictHandler Function<boolean> (可选) - 移动失败时潜在冲突的处理程序。
  - conflictType 字符串 - 处理程序遇到的移动冲突类型；可以是 exists 或 existsAndRunning，其中 exists 表示应用程序目录中存在同名应用程序，而 existsAndRunning 表示它既存在又正在运行。

返回 boolean - 移动是否成功。请注意，如果移动成功，您的应用程序将退出并重新启动。

默认情况下不会显示确认对话框。如果您希望允许用户确认操作，可以使用 dialog API。

注意：如果除用户之外的任何其他原因导致移动失败，此方法会引发错误。例如，如果用户取消授权对话框，此方法将返回 false。如果我们无法执行复制，则此方法将引发错误。错误中的消息应具有信息性，并准确告知出错的原因。

默认情况下，如果与要移动的应用同名的应用存在于应用程序目录中且未运行，则现有应用将被丢弃，活动应用将移入其位置。如果正在运行，则预先存在的正在运行的应用将获得焦点，而先前活动的应用将退出自身。可以通过提供可选的冲突处理程序来更改此行为，其中处理程序返回的布尔值决定是否使用默认行为解决移动冲突。即返回 false 将确保不采取进一步操作，返回 true 将导致默认行为且方法继续。

例如

const { app, dialog } = require('electron')

app.moveToApplicationsFolder({
  conflictHandler: (conflictType) => {
    if (conflictType === 'exists') {
      return dialog.showMessageBoxSync({
        type: 'question',
        buttons: ['Halt Move', 'Continue Move'],
        defaultId: 0,
        message: 'An app of this name already exists'
      }) === 1
    }
  }
})

表示如果应用已存在于用户目录中，如果用户选择“继续移动”，则该函数将继续执行其默认行为，现有应用将被丢弃，活动应用将移入其位置。

`app.isSecureKeyboardEntryEnabled()` macOS

返回 boolean - 是否启用安全键盘输入。

默认情况下，此 API 将返回 false。

`app.setSecureKeyboardEntryEnabled(enabled)` macOS

enabled 布尔值 - 启用或禁用安全键盘输入

在你的应用程序中设置安全键盘输入是否启用。

通过使用此 API，可以防止其他进程截获重要信息（如密码和其他敏感信息）。

有关更多详细信息，请参阅 Apple 文档。

注意：仅在需要时启用安全键盘输入，在不再需要时禁用它。

`app.setProxy(config)`

config ProxyConfig

返回 Promise<void> - 在代理设置过程完成后解析。

设置不带关联会话发出的网络请求的代理设置。目前，这将影响在网络中使用实用程序进程发出的请求和由运行时发出的内部请求（例如：地理位置查询）。

此方法只能在应用准备就绪后调用。

`app.resolveProxy(url)`

url URL

返回 Promise<string> - 使用 Net 在实用程序进程中尝试进行请求时，解析 url 的代理信息。

属性

`app.accessibilitySupportEnabled` macOS Windows

一个 boolean 属性，如果启用了 Chrome 的辅助功能支持，则为 true，否则为 false。如果检测到辅助技术（例如屏幕阅读器）的使用，则此属性将为 true。将此属性手动设置为 true 会启用 Chrome 的辅助功能支持，允许开发者在应用程序设置中向用户公开辅助功能开关。

有关更多详细信息，请参阅 Chromium 的辅助功能文档。默认情况下已禁用。

必须在发出 ready 事件后调用此 API。

注意：渲染辅助功能树会显著影响应用程序的性能。它不应该默认启用。

`app.applicationMenu`

一个 Menu | null 属性，如果已设置 Menu，则返回 Menu，否则返回 null。用户可以传递一个 Menu 来设置此属性。

`app.badgeCount` Linux macOS

一个 Integer 属性，返回当前应用的徽章计数。将计数设置为 0 将隐藏徽章。

在 macOS 上，使用任何非零整数设置此属性都会显示在 Dock 图标上。在 Linux 上，此属性仅适用于 Unity 启动器。

注意：Unity 启动器需要一个 .desktop 文件才能工作。有关更多信息，请阅读 Unity 集成文档。

注意：在 macOS 上，你需要确保你的应用程序有权显示通知，此属性才能生效。

`app.commandLine` 只读

一个 CommandLine 对象，允许你读取和操作 Chromium 使用的命令行参数。

`app.dock` macOS 只读

一个 Dock | undefined 对象，允许您对 macOS 上用户 Dock 中的应用图标执行操作。

`app.isPackaged` 只读

一个 boolean 属性，如果应用已打包，则返回 true，否则返回 false。对于许多应用，此属性可用于区分开发和生产环境。

`app.name`

一个 string 属性，表示当前应用程序的名称，即应用程序 package.json 文件中的名称。

`app.userAgentFallback`

一个 string，它是 Electron 将用作全局后备的用户代理字符串。

当在 webContents 或 session 级别未设置用户代理时，将使用此用户代理。它可用于确保您的整个应用具有相同的用户代理。在应用初始化的尽早阶段将其设置为自定义值，以确保使用您覆盖的值。

`app.runningUnderARM64Translation` 只读 macOS Windows

一个 boolean，当为 true 时表示应用当前正在 ARM64 翻译器（如 macOS Rosetta 翻译器环境或 Windows WOW）下运行。

当用户错误地在 Rosetta 或 WOW 下运行 x64 版本时，您可以使用此属性提示他们下载应用的 arm64 版本。

事件
方法
属性

应用程序

事件​

事件：'will-finish-launching'​

事件：'ready'​

事件：'window-all-closed'​

事件：'before-quit'​

事件：'will-quit'​

事件：'quit'​

事件：'open-file' macOS​

事件：'open-url' macOS​

事件：'activate' macOS​

事件：'did-become-active' macOS​

事件：'did-resign-active' macOS​

事件：'continue-activity' macOS​

事件：'will-continue-activity' macOS​

事件：'continue-activity-error' macOS​

事件：'activity-was-continued' macOS​

事件：'update-activity-state' macOS​

事件：'new-window-for-tab' macOS​

事件：'browser-window-blur'​

事件：'browser-window-focus'​

事件：'browser-window-created'​

事件：'web-contents-created'​

事件：'certificate-error'​

事件：'select-client-certificate'​

事件：'login'​

事件：'gpu-info-update'​

事件：'render-process-gone'​

事件：'child-process-gone'​

事件：'accessibility-support-changed' macOS Windows​

事件：'session-created'​

事件：'second-instance'​

方法​

app.quit()​

app.exit([exitCode])​

app.relaunch([options])​

app.isReady()​

app.whenReady()​

app.focus([options])​

app.hide() macOS​

app.isHidden() macOS​

app.show() macOS​

app.setAppLogsPath([path])​

app.getAppPath()​

app.getPath(name)​

app.getFileIcon(path[, options])​

app.setPath(name, path)​

app.getVersion()​

app.getName()​

app.setName(name)​

app.getLocale()​

app.getLocaleCountryCode()​

app.getSystemLocale()​

app.getPreferredSystemLanguages()​

app.addRecentDocument(path) macOS Windows​

app.clearRecentDocuments() macOS Windows​

app.setAsDefaultProtocolClient(protocol[, path, args])​

app.removeAsDefaultProtocolClient(protocol[, path, args]) macOS Windows​

app.isDefaultProtocolClient(protocol[, path, args])​

app.getApplicationNameForProtocol(url)​

app.getApplicationInfoForProtocol(url) macOS Windows​

app.setUserTasks(tasks) Windows​

app.getJumpListSettings() Windows​

app.setJumpList(categories) Windows​

app.requestSingleInstanceLock([additionalData])​

app.hasSingleInstanceLock()​

app.releaseSingleInstanceLock()​

app.setUserActivity(type, userInfo[, webpageURL]) macOS​

app.getCurrentActivityType() macOS​

app.invalidateCurrentActivity() macOS​

app.resignCurrentActivity() macOS​

app.updateCurrentActivity(type, userInfo) macOS​

app.setAppUserModelId(id) Windows​

app.setActivationPolicy(policy) macOS​

app.importCertificate(options, callback) Linux​

app.configureHostResolver(options)​

app.disableHardwareAcceleration()​

app.disableDomainBlockingFor3DAPIs()​

app.getAppMetrics()​

app.getGPUFeatureStatus()​

事件

事件：'will-finish-launching'

事件：'ready'

事件：'window-all-closed'

事件：'before-quit'

事件：'will-quit'

事件：'quit'

事件：'open-file' macOS

事件：'open-url' macOS

事件：'activate' macOS

事件：'did-become-active' macOS

事件：'did-resign-active' macOS

事件：'continue-activity' macOS

事件：'will-continue-activity' macOS

事件：'continue-activity-error' macOS

事件：'activity-was-continued' macOS

事件：'update-activity-state' macOS

事件：'new-window-for-tab' macOS

事件：'browser-window-blur'

事件：'browser-window-focus'

事件：'browser-window-created'

事件：'web-contents-created'

事件：'certificate-error'

事件：'select-client-certificate'

事件：'login'

事件：'gpu-info-update'

事件：'render-process-gone'

事件：'child-process-gone'

事件：'accessibility-support-changed' macOS Windows

事件：'session-created'

事件：'second-instance'

方法

`app.quit()`

`app.exit([exitCode])`

`app.relaunch([options])`

`app.isReady()`

`app.whenReady()`

`app.focus([options])`

`app.hide()` macOS

`app.isHidden()` macOS

`app.show()` macOS

`app.setAppLogsPath([path])`

`app.getAppPath()`

`app.getPath(name)`

`app.getFileIcon(path[, options])`

`app.setPath(name, path)`

`app.getVersion()`

`app.getName()`

`app.setName(name)`

`app.getLocale()`

`app.getLocaleCountryCode()`

`app.getSystemLocale()`

`app.getPreferredSystemLanguages()`

`app.addRecentDocument(path)` macOS Windows

`app.clearRecentDocuments()` macOS Windows

`app.setAsDefaultProtocolClient(protocol[, path, args])`

`app.removeAsDefaultProtocolClient(protocol[, path, args])` macOS Windows

`app.isDefaultProtocolClient(protocol[, path, args])`

`app.getApplicationNameForProtocol(url)`

`app.getApplicationInfoForProtocol(url)` macOS Windows

`app.setUserTasks(tasks)` Windows

`app.getJumpListSettings()` Windows

`app.setJumpList(categories)` Windows

`app.requestSingleInstanceLock([additionalData])`

`app.hasSingleInstanceLock()`

`app.releaseSingleInstanceLock()`

`app.setUserActivity(type, userInfo[, webpageURL])` macOS

`app.getCurrentActivityType()` macOS

`app.invalidateCurrentActivity()` macOS

`app.resignCurrentActivity()` macOS

`app.updateCurrentActivity(type, userInfo)` macOS

`app.setAppUserModelId(id)` Windows

`app.setActivationPolicy(policy)` macOS

`app.importCertificate(options, callback)` Linux

`app.configureHostResolver(options)`

`app.disableHardwareAcceleration()`

`app.disableDomainBlockingFor3DAPIs()`

`app.getAppMetrics()`

`app.getGPUFeatureStatus()`

`app.getGPUInfo(infoType)`