跳到主要内容
版本:v8

@capacitor/app-launcher

AppLauncher API 允许你的应用检查某个应用能否被打开,并打开该应用。

在 iOS 上,你只能通过已知的 URL scheme 打开应用。

在 Android 上,你可以通过已知的 URL scheme 或使用应用的公开包名来打开应用。

注意:Android 11 及更高版本上,你需要在 AndroidManifest.xmlqueries 标签中添加要查询的应用包名或 URL scheme。

示例:

<queries>
<!-- 按包名查询 -->
<package android:name="com.twitter.android" />
<!-- 按 URL scheme 查询 -->
<intent>
<action android:name="android.intent.action.VIEW"/>
<data android:scheme="twitter"/>
</intent>
</queries>

安装

npm install @capacitor/app-launcher
npx cap sync

示例

import { AppLauncher } from '@capacitor/app-launcher';

const checkCanOpenTwitterUrl = async () => {
const { value } = await AppLauncher.canOpenUrl({ url: 'twitter://timeline' });
console.log('Can open url: ', value);
};

const openTwitterUrl = async () => {
const { completed } = await AppLauncher.openUrl({ url: 'twitter://timeline' });
console.log('openUrl completed: ', completed);
};

// 仅 Android
const checkCanOpenTwitterPackage = async () => {
const { value } = await AppLauncher.canOpenUrl({ url: 'com.twitter.android' });
console.log('Can open package: ', value);
};

// 仅 Android
const openTwitterPackage = async () => {
const { completed } = await AppLauncher.openUrl({ url: 'com.twitter.android' });
console.log('openUrl package completed: ', completed);
};

API

canOpenUrl(...)

canOpenUrl(options: CanOpenURLOptions) => Promise<CanOpenURLResult>

检查是否可以通过给定的 URL 打开某个应用。

在 iOS 上,你必须通过在你的应用的 Info.plist 文件中添加 LSApplicationQueriesSchemes 键来声明传入此方法的 URL scheme。 了解更多关于配置 Info.plist 的信息。

对于未声明的 scheme,此方法始终返回 false,无论是否有合适的应用已安装。要了解更多关于此键的信息,请参阅 LSApplicationQueriesSchemes

在 Android 上,URL 可以是已知的 URLScheme 或应用的包名。

Android 11 及更高版本上,你需要在 AndroidManifest.xmlqueries 标签中添加要查询的应用包名或 URL scheme。

参数类型
options
CanOpenURLOptions

返回值:

Promise<CanOpenURLResult>

自: 1.0.0


openUrl(...)

openUrl(options: OpenURLOptions) => Promise<OpenURLResult>

通过给定的 URL 打开一个应用。 在 iOS 上,URL 应为已知的 URLScheme。 在 Android 上,URL 可以是已知的 URLScheme 或应用的包名。

参数类型
options
OpenURLOptions

返回值:

Promise<OpenURLResult>

自: 1.0.0


接口

CanOpenURLResult

属性类型
valueboolean

CanOpenURLOptions

属性类型
urlstring

OpenURLResult

属性类型
completedboolean

OpenURLOptions

属性类型
urlstring