メインコンテンツへスキップ

@capgo/capacitor-app-intents

Capacitor から Siri フレーズ、ショートカット、Spotlight、ホーム画面のクイックアクション、エンティティカタログを、コールドスタートでも安全な呼び出しキューで配信。

@capgo/capacitor-app-intents Appleの App Intentsを Capacitor JavaScriptレイヤーに接続します。コールドスタート時の保留中のキューの処理、Shortcutsパラメータ用のエンティティカタログの公開、Spotlightコンテンツのインデックス作成、ホーム画面のクイックアクションの設定、および appIntentInvoked イベントの待機が可能です。Siriショートカットの フレーズは、 実行時の文字列ではなく、生成されたSwift内のコンパイル時リテラルとして扱われます。

Widget Kit、Live Activities、Share Target、またはIntent Launcherも併用する場合は、このプラグインを Siri、ショートカット、ウィジェット と組み合わせて使用してください。

プラットフォームサポート備考
iOSとはいiOS 16以降
Androidではいいえメソッドは明確なエラーを返します
WebいいえCapacitor.getPlatform() でガード
  • getPendingInvocations - JavaScriptの準備ができる前にキューに追加された呼び出しを返します。
  • removePendingInvocation - ハンドラーでの処理完了後、保留中の呼び出しを1つ削除します。
  • setEntityCatalog - 指定した型文字列に対してエンティティカタログを永続化します。
  • setHomeScreenShortcutItems - ホーム画面のクイックアクション (UIApplicationShortcutItems) を置き換えます。
メソッド説明
getPendingInvocationsJavaScriptの準備ができる前にキューに溜まった呼び出しを返します。
removePendingInvocationハンドラーでの処理完了後、保留中の呼び出しを1つ削除します。
setEntityCatalog指定された型文字列のエンティティカタログを永続化します。
setHomeScreenShortcutItemsホーム画面のクイックアクション (UIApplicationShortcutItems) を置き換えます。
indexSpotlightEntitiesアプリのドメインのSpotlightアイテムをインデックスします。
removeSpotlightEntitiesSpotlightの項目をIDで削除します。
performAppleSchemaTemplateアルファ版のAppleスキーマテンプレート用のJavaScriptハンドラーをキューに追加します。
addListenerを監視します: appIntentInvoked 新しい呼び出しがキューに追加されたとき。
removeAllListenersこのプラグインのすべてのリスナーを削除します。
getPluginVersionNative プラグインのバージョン文字列。

このリファレンスは以下から同期されています: src/definitions.ts における capacitor-app-intents.