版本：v4

@capacitor/app

App API 处理高级别的应用状态和事件。例如，此 API 在应用进入和离开前台时发出事件、处理深层链接、打开其他应用以及管理持久化的插件状态。

安装

npm install @capacitor/app
npx cap sync

iOS

为了能够通过自定义方案打开应用，您需要先注册该方案。您可以通过编辑 Info.plist 文件并添加以下内容来完成。

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLName</key>
    <string>com.getcapacitor.capacitor</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>mycustomscheme</string>
    </array>
  </dict>
</array>

Android

为了能够通过自定义方案打开应用，您需要先注册该方案。您可以通过在 AndroidManifest.xml 的 activity 部分中添加以下内容来完成。

<intent-filter>
    <action android:name="android.intent.action.VIEW" />
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="@string/custom_url_scheme" />
</intent-filter>

custom_url_scheme 值存储在 strings.xml 中。当添加 Android 平台时，@capacitor/cli 会添加应用的包名作为默认值，但可以通过编辑 strings.xml 文件来替换。

示例

import { App } from '@capacitor/app';

App.addListener('appStateChange', ({ isActive }) => {
  console.log('应用状态已改变。是否活跃？', isActive);
});

App.addListener('appUrlOpen', data => {
  console.log('应用通过 URL 打开：', data);
});

App.addListener('appRestoredResult', data => {
  console.log('已恢复的状态：', data);
});

const checkAppLaunchUrl = async () => {
  const { url } = await App.getLaunchUrl();

  console.log('应用通过 URL 打开：' + url);
};

exitApp()

exitApp() => Promise<void>

强制退出应用。这应仅与 Android 的 backButton 处理程序配合使用，以在导航完成时退出应用。

如果使用 Ionic，Ionic 会自行处理此操作，因此您不需要调用此方法。

自从： 1.0.0

getInfo()

getInfo() => Promise<AppInfo>

返回关于应用的信息。

返回：

Promise<AppInfo>

自从： 1.0.0

getState()

getState() => Promise<AppState>

获取当前应用状态。

返回：

Promise<AppState>

自从： 1.0.0

getLaunchUrl()

getLaunchUrl() => Promise<AppLaunchUrl | undefined>

获取应用启动时的 URL（如果有）。

返回：

Promise<AppLaunchUrl>

自从： 1.0.0

minimizeApp()

minimizeApp() => Promise<void>

最小化应用。

仅适用于 Android。

自从： 1.1.0

addListener('appStateChange', ...)

addListener(eventName: 'appStateChange', listenerFunc: StateChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

监听应用或活动状态的变化。

在 iOS 上，当原生 UIApplication.willResignActiveNotification 和 UIApplication.didBecomeActiveNotification 事件被触发时调用。在 Android 上，当 Capacitor 的 Activity 的 onResume 和 onStop 方法被调用时触发。在 Web 上，当文档的 visibilitychange 事件被触发时调用。

参数	类型
`eventName`	`'appStateChange'`
`listenerFunc`	`StateChangeListener`

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

自从： 1.0.0

addListener('pause', ...)

addListener(eventName: 'pause', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听应用或活动暂停时。

在 iOS 上，当原生 UIApplication.didEnterBackgroundNotification 事件被触发时调用。在 Android 上，当 Capacitor 的 Activity 的 onPause 方法被调用时触发。在 Web 上，当文档的 visibilitychange 事件被触发且 document.hidden 为 true 时调用。

参数	类型
`eventName`	`'pause'`
`listenerFunc`	`() => void`

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

自从： 4.1.0

addListener('resume', ...)

addListener(eventName: 'resume', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听应用或活动恢复时。

在 iOS 上，当原生 UIApplication.willEnterForegroundNotification 事件被触发时调用。在 Android 上，当 Capacitor 的 Activity 的 onResume 方法被调用时触发，但仅在 resume 首次触发之后。在 Web 上，当文档的 visibilitychange 事件被触发且 document.hidden 为 false 时调用。

参数	类型
`eventName`	`'resume'`
`listenerFunc`	`() => void`

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

自从： 4.1.0

addListener('appUrlOpen', ...)

addListener(eventName: 'appUrlOpen', listenerFunc: URLOpenListener) => Promise<PluginListenerHandle> & PluginListenerHandle

监听应用的 URL 打开事件。这同时处理自定义 URL 方案链接以及您的应用处理的 URL（iOS 上的 Universal Links 和 Android 上的 App Links）。

参数	类型
`eventName`	`'appUrlOpen'`
`listenerFunc`	`URLOpenListener`

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

自从： 1.0.0

addListener('appRestoredResult', ...)

addListener(eventName: 'appRestoredResult', listenerFunc: RestoredListener) => Promise<PluginListenerHandle> & PluginListenerHandle

如果应用是通过先前持久化的插件调用数据启动的，例如在 Android 上当一个 Activity 返回到一个已关闭的应用时，此调用将返回应用启动时携带的任何数据，并转换为插件调用的结果形式。

在 Android 上，由于低端设备的内存限制，如果您的应用启动了一个新的 Activity，操作系统可能会终止您的应用以减少内存消耗。

例如，这意味着启动新 Activity 来拍照的 Camera API 可能无法将数据返回到您的应用。

为了避免这种情况，Capacitor 会在启动时存储所有已恢复的 Activity 结果。您应该为 appRestoredResult 添加一个监听器，以处理在您的应用未运行时传递的任何插件调用结果。

一旦获得了该结果（如果有），您可以更新 UI 以为用户恢复合乎逻辑的体验，例如导航或选择正确的标签页。

我们建议每个使用依赖外部 Activity（例如 Camera）的插件的 Android 应用都处理此事件和流程。

参数	类型
`eventName`	`'appRestoredResult'`
`listenerFunc`	`RestoredListener`

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

自从： 1.0.0

addListener('backButton', ...)

addListener(eventName: 'backButton', listenerFunc: BackButtonListener) => Promise<PluginListenerHandle> & PluginListenerHandle

监听硬件返回按钮事件（仅限 Android）。监听此事件将禁用默认的返回按钮行为，因此您可能需要手动调用 window.history.back()。如果要关闭应用，请调用 App.exitApp()。

参数	类型
`eventName`	`'backButton'`
`listenerFunc`	`BackButtonListener`

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

自从： 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

移除该插件的所有原生监听器。

自从： 1.0.0

接口

AppInfo

属性	类型	描述	自从
`name`	`string`	应用的名称。	1.0.0
`id`	`string`	应用的标识符。在 iOS 上是 Bundle Identifier。在 Android 上是 Application ID。	1.0.0
`build`	`string`	构建版本。在 iOS 上是 CFBundleVersion。在 Android 上是 versionCode。	1.0.0
`version`	`string`	应用版本。在 iOS 上是 CFBundleShortVersionString。在 Android 上是 package 的 versionName。	1.0.0

AppState

属性	类型	描述	自从
`isActive`	`boolean`	应用是否处于活跃状态。	1.0.0

AppLaunchUrl

属性	类型	描述	自从
`url`	`string`	用于打开应用的 URL。	1.0.0

PluginListenerHandle

属性	类型
`remove`	`() => Promise<void>`

URLOpenListenerEvent

属性	类型	描述	自从
`url`	`string`	应用被打开时的 URL。	1.0.0
`iosSourceApplication`	`any`	打开应用的源应用（仅限 iOS）。https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623128-sourceapplication	1.0.0
`iosOpenInPlace`	`boolean`	应用是否应就地打开传递的文档还是必须先复制它。https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623123-openinplace	1.0.0

RestoredListenerEvent

属性	类型	描述	自从
`pluginId`	`string`	此结果对应的 pluginId。例如 `Camera`。	1.0.0
`methodName`	`string`	此结果对应的 methodName。例如 `getPhoto`。	1.0.0
`data`	`any`	从插件传递的结果数据。这将是您通常调用插件方法时预期的结果。例如 `CameraPhoto`。	1.0.0
`success`	`boolean`	指示插件调用是否成功的布尔值。	1.0.0
`error`	`{ message: string; }`	如果插件调用未成功，将包含错误消息。	1.0.0

BackButtonListenerEvent

属性	类型	描述	自从
`canGoBack`	`boolean`	指示浏览器是否可以在历史记录中返回。当历史记录栈位于第一个条目时为 false。	1.0.0

类型别名

StateChangeListener

(state: AppState): void

URLOpenListener

(event: URLOpenListenerEvent): void

RestoredListener

(event: RestoredListenerEvent): void

BackButtonListener

(event: BackButtonListenerEvent): void

安装​

iOS​

Android​

示例​

API​

exitApp()​

getInfo()​

getState()​

getLaunchUrl()​

minimizeApp()​

addListener('appStateChange', ...)​

addListener('pause', ...)​

addListener('resume', ...)​

addListener('appUrlOpen', ...)​

addListener('appRestoredResult', ...)​

addListener('backButton', ...)​

removeAllListeners()​

接口​

AppInfo​

AppState​

AppLaunchUrl​

PluginListenerHandle​

URLOpenListenerEvent​

RestoredListenerEvent​

BackButtonListenerEvent​

类型别名​

StateChangeListener​

URLOpenListener​

RestoredListener​

BackButtonListener​

Contents

安装

iOS

Android

示例

API

exitApp()

getInfo()

getState()

getLaunchUrl()

minimizeApp()

addListener('appStateChange', ...)

addListener('pause', ...)

addListener('resume', ...)

addListener('appUrlOpen', ...)

addListener('appRestoredResult', ...)

addListener('backButton', ...)

removeAllListeners()

接口

AppInfo

AppState

AppLaunchUrl

PluginListenerHandle

URLOpenListenerEvent

RestoredListenerEvent

BackButtonListenerEvent

类型别名

StateChangeListener

URLOpenListener

RestoredListener

BackButtonListener