跳到主要内容
版本：v2

App

App API 用于处理应用的高级状态和事件。

例如，当应用进入或退出前台时，该 API 会发出事件，处理深度链接、打开其他应用以及管理持久化的插件状态。

关于 canOpenUrl 的注意事项​

使用 canOpenUrl 时，需要在 Info.plist 的 LSApplicationQueriesSchemes 中设置应用要查询的 URL 方案。

了解更多关于 LSApplicationQueriesSchemes 和 配置 Info.plist 的信息。

示例​

import { Plugins, AppState } from '@capacitor/core';

const { App } = Plugins;

App.addListener('appStateChange', (state: AppState) => {
  // state.isActive 包含当前激活状态
  console.log('应用状态变更。是否激活？', state.isActive);
});

var ret = await App.canOpenUrl({ url: 'com.getcapacitor.myapp' });
console.log('是否可以打开 URL: ', ret.value);

ret = await App.openUrl({
  url: 'com.getcapacitor.myapp://page?id=ionicframework',
});
console.log('打开 URL 的响应: ', ret);

ret = await App.getLaunchUrl();
if (ret && ret.url) {
  console.log('应用通过 URL 打开: ' + ret.url);
}
console.log('启动 URL: ', ret);

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

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

Android: 使用 appRestoredResult​

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

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

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

一旦获得结果（如果有），您可以更新用户界面，恢复用户的逻辑体验，例如导航或选择正确的选项卡。

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

API​

exitApp()​

exitApp() => never

强制退出应用。此方法应仅与 Android 的 backButton 处理程序结合使用，以便在导航完成后退出应用。

Ionic 会自行处理此情况，因此如果您使用 Ionic，则无需调用此方法。

返回值: never

canOpenUrl(...)​

canOpenUrl(options: { url: string; }) => Promise<{ value: boolean; }>

检查是否可以使用给定 URL 打开应用

参数类型
options{ url: string; }

返回值: Promise<{ value: boolean; }>

openUrl(...)​

openUrl(options: { url: string; }) => Promise<{ completed: boolean; }>

使用给定 URL 打开应用

参数类型
options{ url: string; }

返回值: Promise<{ completed: boolean; }>

getState()​

getState() => Promise<AppState>

获取当前应用状态

返回值: 

Promise<AppState>

getLaunchUrl()​

getLaunchUrl() => Promise<AppLaunchUrl>

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

返回值: 

Promise<AppLaunchUrl>

addListener(...)​

addListener(eventName: 'appStateChange', listenerFunc: (state: AppState) => void) => PluginListenerHandle

监听应用活动状态的变化（应用是否在前台或后台）

参数类型
eventName"appStateChange"
listenerFunc
(state: AppState) => void

返回值: 

PluginListenerHandle

addListener(...)​

addListener(eventName: 'appUrlOpen', listenerFunc: (data: AppUrlOpen) => void) => PluginListenerHandle

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

参数类型
eventName"appUrlOpen"
listenerFunc
(data: AppUrlOpen) => void

返回值: 

PluginListenerHandle

addListener(...)​

addListener(eventName: 'appRestoredResult', listenerFunc: (data: AppRestoredResult) => void) => PluginListenerHandle

如果应用启动时带有之前持久化的插件调用数据（例如在 Android 上当 Activity 返回到已关闭的应用时），此调用将返回应用启动时携带的任何数据，这些数据会被转换为插件调用的结果形式。

参数类型
eventName"appRestoredResult"
listenerFunc
(data: AppRestoredResult) => void

返回值: 

PluginListenerHandle

addListener(...)​

addListener(eventName: 'backButton', listenerFunc: (data: AppUrlOpen) => void) => PluginListenerHandle

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

参数类型
eventName"backButton"
listenerFunc
(data: AppUrlOpen) => void

返回值: 

PluginListenerHandle

removeAllListeners()​

removeAllListeners() => void

移除此插件的所有本地监听器

Interfaces​

AppState​

属性类型
isActiveboolean

AppLaunchUrl​

属性类型
urlstring

PluginListenerHandle​

属性类型
remove() => void

AppUrlOpen​

属性类型描述
urlstring应用打开的 URL
iosSourceApplicationany打开应用的源应用程序（仅限 iOS） https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623128-sourceapplication
iosOpenInPlaceboolean应用是否应在原地打开传递的文档还是必须先复制它。 https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623123-openinplace

AppRestoredResult​

属性类型描述
pluginIdstring此结果对应的 pluginId。例如 Camera。
methodNamestring此结果对应的 methodName。例如 getPhoto。
dataany从插件传递的结果数据。这将是您从正常调用插件方法时期望的结果。例如 CameraPhoto
successboolean布尔值，指示插件调用是否成功
error{ message: string; }如果插件调用未成功，它将包含错误消息

Contents

编辑此页