メインコンテンツにスキップ
バージョン: v8

@capacitor/app-launcher

AppLauncher API を使用すると、アプリが別のアプリを開けるかどうかを確認し、開くことができます。

iOS では、URL スキームがわかっている場合にのみアプリを開くことができます。

Android では、URL スキームがわかっている場合、またはパブリック パッケージ名を使用する場合にアプリを開くことができます。

注意: Android 11 以降では、クエリを実行するアプリのパッケージ名を AndroidManifest.xml 内の queries タグに追加する必要があります。

<queries>
<package android:name="com.getcapacitor.myapp" />
</queries>

インストール

npm install @capacitor/app-launcher
npx cap sync

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

const checkCanOpenUrl = async () => {
const { value } = await AppLauncher.canOpenUrl({ url: 'com.getcapacitor.myapp' });

console.log('Can open url: ', value);
};

const openPortfolioPage = async () => {
await AppLauncher.openUrl({ url: 'com.getcapacitor.myapp://page?id=portfolio' });
};

API

canOpenUrl(...)

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

指定された URL でアプリを開けるかどうかを確認します。

iOS では、このメソッドに渡す URL スキームを、アプリの Info.plist ファイルに LSApplicationQueriesSchemes キーを追加することで宣言する必要があります。Info.plist の設定の詳細をご覧ください。

このメソッドは、適切なアプリがインストールされているかどうかにかかわらず、宣言されていないスキームに対して常に false を返します。キーの詳細については、LSApplicationQueriesSchemes を参照してください。

パラメータタイプ
オプションCanOpenURLOptions

戻り値: Promise<CanOpenURLResult>

提供開始 1.0.0


openUrl(...)

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

指定された URL でアプリを開きます。iOS では、URL は既知の URL スキームである必要があります。Android では、URL は既知の URL スキームまたはアプリのパッケージ名にすることができます。

パラメータタイプ
オプションOpenURLOptions

戻り値: Promise<OpenURLResult>

提供開始 1.0.0


インターフェース

CanOpenURLResult

プロパティタイプ
boolean

CanOpenURLOptions

プロパティタイプ
urlstring

OpenURLResult

プロパティタイプ
完了boolean

OpenURLOptions

プロパティタイプ
urlstring