@capacitor/app-launcher

应用启动器 API 允许您的应用程序检查应用是否可以打开并打开它。

在 iOS 上,您只有在知道应用的 URL scheme 时才能打开它们。

在 Android 上,您可以在知道应用的 URL scheme 或使用其公共包名的情况下打开它们。

注意: 在 Android 11 及更高版本上,您必须在 AndroidManifest.xml 的 queries 标签中添加要查询的应用包名或 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(...)
• openUrl(...)
• Interfaces

canOpenUrl(...)

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

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

在 iOS 上,您必须通过将 LSApplicationQueriesSchemes 键添加到应用程序的 Info.plist 文件中来声明传递给此方法的 URL scheme。 了解有关配置 Info.plist 的更多信息。

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

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

在 Android 11 及更高版本上,您必须在 AndroidManifest.xml 的 queries 标签中添加要查询的应用包名或 URL scheme。

Param	Type
options	CanOpenURLOptions

Returns:

Promise<CanOpenURLResult>

Since: 1.0.0

---

openUrl(...)

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

使用给定的 URL 打开应用。 在 iOS 上,URL 应该是已知的 URLScheme。 在 Android 上,URL 可以是已知的 URLScheme 或应用包名。

Param	Type
options	OpenURLOptions

Returns:

Promise<OpenURLResult>

Since: 1.0.0

---

Interfaces

CanOpenURLResult

Prop	Type
value	boolean

CanOpenURLOptions

Prop	Type
url	string

OpenURLResult

Prop	Type
completed	boolean

OpenURLOptions

Prop	Type
url	string