Appインテントの詳細

Appインテントの詳細

App Intentsフレームワークで、Appを見つけやすくし、Appのエンゲージメントを向上させる方法をご確認ください。Swiftフレームワークの強力な機能をはじめ、AppインテントとSiriKitインテントの違い、Appの機能をシステムに公開する方法について解説します。また、豊富なAppショートカット体験をもたらすエンティティやクエリを作成する方法も紹介します。 Appインテントのさらなる詳細については、WWDC22の「AppインテントによるAppショートカットの実装」および「Appショートカットのデザイン」をご確認ください。

リソース
- App Intents
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC23
- ウィジェットに命を吹き込む方法
Tech Talks
- エンタープライズデベロッパ向けの最新情報
- カスタムインテントのApp Intentへの移行
WWDC22
WWDC21
- ショートカット、Siri、提案のための優れたアクションのデザイン
ダウンロード

♪ 明るい音楽ヒップホップミュージック♪ ♪ みなさんこんにちは Michael Gorbachです Shortcuts Engineeringに所属していますこの度は Appの機能をシステムに公開するための新しいフレームワーク Appインテントについて詳しく見ていきますこちらが今回見ていくプランです導入部分を簡潔に説明した後にインテントやパラメータについて話しエンティティの定義について話します強力な検索機能やフィルタリング機能を構築しインテントがどのようにユーザーとインタラクションするのか確認します最後にAppインテントのアーキテクチャおよびライフサイクルについて説明します初めから見ていきましょう iOS 10では SiriKit Intents フレームワークを導入しメッセージワークアウト支払いなどのSiriのドメインに Appの機能を対応させられるようにしました今回はAppインテントという新しいフレームワークを導入します 3つの重要なコンポーネントがありますインテントは Appに組み込まれたアクションのことでシステム全体で使用することができますインテントはエンティティを使用して Appのコンセプトを表現します Appショートカットはインテントをラップすることで自動的かつインテントを発見しやすくします Appインテントによって Appの機能をより多くの場所で利用できるようになりどのように顧客に利益を提供できるのか話していきます Appショートカットを使うと最初に何も設定しなくても誰でも音声で Siriを通して Appの機能を使うことができます同じ実装で Spotlightで Appを検索した際や Appが提案された際にインテントが表示されますこれによりみなさんの仕事が前面の中央へと現れます Appインテントを使用して集中モードフィルタを構築できます顧客は特別な集中モード用に Appをカスタマイズできます例えばカレンダーAppを設定して仕事中に仕事のカレンダーのみを表示することができます集中モードフィルタを導入する方法についてこちらセッションで詳しく確認してください Appショートカットを使用するとインテントがショートカットAppにマニュアルでの追加の必要なく自動的に表示されますショートカットにAppのアクションを統合することは顧客にとって非常に価値あることですというのもシステムを通じて様々な場所からショートカットを呼び出すことで Appの機能を活用できるためですホーム画面のシングルタップや macOSのメニューバーからそれ以外の様々な場所からもショートカットを実行できますオートメーションによって自動的に実行されるショートカットを設定することもできますショートカットをサポートすることで Appがショートカットエコシステム全体とつながり Appleや他のデベロッパのさまざまな Appの力を借りてパワーと能力を倍増させることができますショートカットは複数のappのアクションを組み合わせることができるためユーザーが何もしなくてもまったく新しい機能や性能を生み出すことができるからですみなさんのアクションを他とうまく連動させこのエコシステムにシームレスに適合させる方法を確認するには私どものデザインに関するセッションを確認してください Appインテントを構築する目的は開発する楽しみを感じてもらうことでした Appインテントは簡潔に使用できます単純なインテントを書くには数行のコードだけですが APIはより深くカスタマイズ可能なアクションにもスケールします Resultビルダープロパティラッパープロトコル指向プログラミングジェネリックスを活用し Swiftに全面的に取り組んできましたこれらのAPIは最先端の言語機能なしには機能できません Appインテントの導入は簡単ですプロダクトやターゲットの再設計やフレームワークの作成は必要ありません Extensionも必要とせず App内ですぐに対応できます Appインテントのコードはメンテナンス面の特徴もあります SwiftUIなどと同様 Appインテントはコードを基盤となる信頼できるソースとして使用するため別のエディタや定義ファイルの必要性を回避することができますこれにより迅速な構築と採用における反復が可能になりすべてが一箇所に集約されるためメンテナンスも簡素化されますそれでは新しいフレームワークの主要な構成要素であるインテントから
これらの新しい APIを見ていきます Appインテント略してインテントは Appがシステムに公開する単一で分離された機能の単位です例えばインテントには新しいカレンダーイベントを作成特定の画面を開く注文するなどがありますインテントはショートカットの実行やSiriでの検索などユーザーのリクエストに応じて実行することも集中モードフィルタやショートカットオートメーションを使って自動的に実行することも可能ですインテントを実行する際に結果を返すかエラーを投げるかのどちらかになりますインテントには次の3つの重要な要素が含まれますローカライズされたタイトルなどのインテントに関するメタデータや情報インテントが実行される際に使用できる入力となるパラメータそしてインテントが実行される際に実際の作業を行う performメソッドです本日は読書Appから話していきます私は大の読書家のため読んだ本読みたい本現在読んでいる本を記録したいと思っています Shelfという Appの個別タブに各カテゴリが表示されますユーザーがいつも現在読んでいる本の Shelfを訪れるので Appインテントを公開してより素早くより便利にこれを開けるようにします AppIntent プロトコルに準拠した Swiftの構造体を定義することで OpenCurrentlyReading インテントをここに作成します実装が必要なメソッドは performメソッドだけです Appにはタブを開く Navigatorがすでにあるため私にとってのインテントの実装は数行のコードのみです Navigatorはメインスレッドを想定しているため performメソッドに@MainActorのアノテーションを付けますインテントにはタイトルも必要です本日紹介する他の文字列のようにキーをstringsファイルに追加すると自動的にローカライズされますここまでがAppインテントのために必要な基本的な実装ですコードで定義されたのでショートカットエディタに自動的に表示されますそこでユーザーがショートカットに追加できますこのインテントを公開するだけで大きな効果が得られます顧客がこのインテントをショートカットにすればシステムの様々な場所からインテントが使用可能になるからですこの新しいインテントを簡単に使え見つけられるように Appショートカットのサポートを追加しますほんの少しのコードで SpotlightやショートカットAppにインテントを自動的に表示させることができ Siriに対する音声経由でこのインテントを使うためのフレーズも定義することができますすべての詳細につきましては「Appインテントによる Appショートカットの実装」セッションをご確認くださいインテントを公開して現在読んでいる本の Shelfを開きます次にこれを一般化してどのShelfにも開けるようにパラメータを追加しましょう Shelfを表す enumがありますパラメータとして使用するために AppEnumプロトコルに対応させる必要があります AppEnumには StringのRawデータが必要であるためまず最初に追加します各enumのケースにはローカライズ可能で人が認識できるタイトルを付ける必要がありますコンパイラはビルド時にこのコードを読むためこれらは辞書リテラルとして提供される必要があります最後に typeDisplayName を追加しますこれはこの列挙型全体に対するユーザから見えるローカライズ可能な名前です「Shelf」を使用しますインテントでは各パラメータは @Parameterプロパティラッパーで宣言されタイトルなどのパラメータに対する情報で初期化されますここでは performメソッドで読み込む新しいshelfパラメータを定義しますパラメータは数値文字列ファイルなどの他にもエンティティや列挙型などこれらすべての型に対応していますこのインテントをショートカットエディタで表示するとこのようになります Shelfパラメータはテーブルに示されています ParameterSummary APIを使うことで UIをより合理的にしショートカットにうまく適合できますパラメータサマリは「Open 」のようにエディタ内でインテントとそのパラメータを表す文章表現ですショートカットのベストな結果のためにも作成するすべてのインテントでパラメータサマリを常に提供することをお勧めしますどのパラメータを下に表示または非表示にするか定義することができますこれらのAPIには WhenとOtherwise API またはSwitch Case Default APIを使用してインテントの任意のパラメータの実際の値に基づいてサマリを変化させるなど優れた機能がありますパラメータサマリを追加するためにこのstaticプロパティを実装しますここでは文字列「Open」を返し shelfパラメータを補間します Open Shelfを機能させるために最後に必要なことはこのようにインテントを実行すると読書Appが開くようにすることです Appの起動は staticプロパティ openAppWhenRun で管理しますデフォルトはfalseでほとんどのインテントに合致していますしかしこのようにUIで何かを開くインテントの場合この値をtrueに設定する必要がありますちょうど今Shelfを開くためのインテントを作成しました Shelfのセットを修復したのでこちらは非常に簡潔なりました Bookを開くインテントを構築したい場合そのセットが固定ではなく動的なものであればどうでしょうかそのためにエンティティが必要になりますエンティティとは Appインテントに Appが公開するコンセプトですメモAppのノートや写真Appの写真やアルバムなど値が動的またはユーザー定義の場合は列挙型の代わりにエンティティを使用する必要がありますエンティティのインスタンスを提供するために Appでクエリを実装しインテントから結果としてエンティティを返すことができます Appで本を開くというインテントを作成することから始めますショートカットエディタではこのように表示されます Bookパラメータをタップすると Appが提供する提案されたエンティティのセットを含む本を選択するピッカーが利用できますピッカーの上部にあるこの検索フィールドを使えばライブラリにあるどんな本でも探すことができますインテント自体を構築する前に本のエンティティとそれに対応するクエリを作成する必要がありますエンティティは少なくとも識別子ディスプレイ表現エンティティ型の名前 3つを含みますエンティティを追加するには構造体を AppEntityプロトコルと適合することから始めますここではBookEntityの新しい構造体を定義しますがモデルから既存の型を適合させることもできます Identifiable プロトコルにエンティティを適合させることで識別子を提供します Appインテントはこの識別子を使用してAppとシステムの他の部分との間で送信されるエンティティを参照します識別子は顧客が作成したショートカットに保存される可能性があるため安定かつ永続的であることが必要ですディスプレイ表現はこのエンティティをユーザーに表示するために使用されますこれは本のタイトルなどのテキストの文字列を単純なものにできますサブタイトルや画像を提供することも可能です typeDisplayNameはエンティティ型を表す人が読みやすい文字列ですこの例では「Book」ですここで本のエンティティを実行するためにクエリを追加する必要がありますクエリはAppからエンティティを取得するためのインターフェイスをシステムに提供しますクエリではいくつかの方法でエンティティを検索できますすべてのクエリは識別子に基づいたエンティティを検索できる必要があります文字列クエリで検索をサポートします後ほどより柔軟性の高いプロパティクエリをご案内しますすべてのクエリでユーザーがリストから選択できるようにエンティティの提案を提供することもできますすべてのエンティティはクエリと関連付けられる必要があるためシステムがそのエンティティのインスタンスを検索できるようになります EntityQuery プロトコルに準拠した Swiftの構造体を作成してクエリを提供します基本的なクエリには必須メソッドが1つありそれを実装することで識別子の配列を取得してエンティティを解決しますモデルデータベースにアクセスしてその識別子に一致する本を探すことでこれを実装しましたクエリをエンティティにフックする必要があります BookEntity型の defaultQuery staticプロパティを実装し BookQueryのインスタンスを返すことでこれを実現していますユーザーが本を選ぶ際にその識別子がショートカットに保存されますショートカットを実行すると Appインテントはこの識別子をクエリに渡し BookEntity インスタンスを取得します BookEntity型が AppEntityプロトコルに適合することで OpenBookインテントのパラメータとして使用できます performメソッドは Navigatorを介して本へと遷移させます
本のピッカーをサポートするためにクエリは提案された結果も提供する必要がありますそのためには読書Appに追加されたすべての本を返すもう1つのメソッドをクエリに実装する必要がありますショートカットはこれらの結果でピッカーを埋めますショートカットUIには上部に検索フィールドがあります Appはたくさんの本のエンティティを持つ可能性があるため本当はAppのプロセスで直接データベースに対して検索を実行する必要があります StringQuery APIを使うとそれができます StringQueryサブプロトコルを採用することで文字列を指定して結果を返す entity (matching string:) というもう一つのメソッドを実装できるようになりましたここでは本のタイトルに対して単純に大文字小文字を区別しないマッチングで実装していますが例えば著者名やシリーズ名から検索するなどよりファンシーなことも可能です膨大な数と少ない数のお気に入りの本のリストがある場合 suggestedEntitiesでお気に入りだけを返し entities (matching string:) でユーザーが長いリスト全体を検索できます Appで本を開く方法を公開しその過程で本のエンティティと本のクエリを構築しました同じエンティティとクエリを使用してインテントをもっと作成できます次のタスクはインテントを構築してライブラリに本を追加することです顧客は共有シートのショートカットを使用してオンラインを閲覧しながら素早く本を追加したり画面を見ることなく HomePodのSiriに本の追加を指示したりすることが可能ですこのようにUIを表示することなくモデルを直接操作するインテントを構築することでユーザーに力を与えることができます本のタイトルと著者のオプション名をパラメータとして取る AddBookインテントの実装がありますどの友人がその本を勧めたかを記録するためのメモもオプションで用意されています performメソッドでは async/awaitを使用した APIコールで本を調べてライブラリに追加します一致するものが見つからない場合はエラーを投げますこのエラーをローカライズするためにエラー型を CustomLocalizedStringResource Convertibleプロトコルに適合しますこのプロパティからローカライズされた文字列のキーを返してそのキーをstringsファイルに追加しますこのAdd Bookインテントは Siriやウィジェットなどのためにそのままでも驚くほど便利です他のインテントと組み合わせることができる場合さらに柔軟性が高まります少しの作業をすることで AddBookインテントを先ほど構築した OpenBookインテントと組み合わせ一方からもう一方に結果を渡すことができますそのためにAddBook インテントの結果の一部として値を返すようにします performメソッドの戻り値の型に新しいプロトコルが追加されたことに注目してくださいユーザーはこのインテントの結果値をパラメータとして本のエンティティを受け取る他のエンティティに接続ができます AddBookインテントと OpenBookインテントが自然に組み合わさるため本を追加してすぐにライブラリで開くショートカットを作成することができますインテントから結果を返してそれをAppで開くことはよくあることです Appインテントには openIntentという表現方法が組み込まれています openIntentを追加すると顧客はショートカットに「Open When Run」という新しいスイッチを取得することになりますスイッチをオフにする場合このインテントをショートカットの一部としてバックグラウンドで中断することなく使用できるようになりますスイッチを入れたままにした場合新しく追加された本がすぐに読書Appで開きます openIntentの採用は OpenBookインテントのインスタンスを作成し結果の一部として返すと簡単ですこのインテントを実行する際に Open When Runスイッチがオンになっていると AddBookインテントが終了した後に OpenBookインテントが自動的に実行されますエンティティおよびクエリを使用してたくさんのことが実行できます次のAPIセットによって SiriKit Intentsフレームワークではこれまでに実現できなかったような強力な機能を Appインテントで活用できますエンティティの情報をより多く公開し顧客がその情報を基に検索やフィルタリングする方法について説明しますこれまで本のエンティティに必要な基本的要件をすべて追加しています本をもっと深くショートカットに組み込むには本についてもう少し公開する必要がありそうですエンティティはプロパティをサポートしておりユーザーに公開したいエンティティの追加情報を保持します今回の場合は本の著者出版日読書日推薦者を追加しショートカットでそれらのプロパティを使うことができます BookEntityにプロパティを追加するには @Propertyというプロパティラッパーを使用しますプロパティはパラメータと同じ型に対応しておりそれぞれローカライズされたタイトルを取りますこれらの新しいプロパティにより顧客は本のエンティティを処理する際にショートカットのマジック変数を使用してそれぞれ新しい情報を引き出すことができるようになりました先ほどのAddBook インテントを使用する際新たに追加された本の著者や出版日をショートカットで使用することができます
プロパティとクエリを組み合わせる際に Appは自動的にこの柔軟な述語エディタUIを備えた非常に強力な検索とフィルタアクションをショートカットに対し得ることができますこれで顧客は読書日タイトル著者名などに基づいて本を検索しフィルタリングできるようになりました例えば Delia Owensの本をすべて探すのは非常に簡単なことです Sort byやLimit オプションを使えば Delia Owensの最近出版された 3冊の本を探すなどさらに高度なクエリに対応することができます顧客はこの構成要素を使ってコレクションの中で最も著名な 3名の作家を見つけるなど非常に優れた機能が利用できますこれらすべてを可能にするためにプロパティクエリという別の種類のクエリを採用する必要がありますプロパティクエリは文字列や識別子に基づくのではなくエンティティ内のプロパティに基づいてエンティティを検索しますプロパティクエリの実装には 3つのステップがありますまず最初にクエリプロパティを宣言してそのプロパティを使用してエンティティを検索する方法を指定します次にソートオプションを追加しクエリ結果のソート方法を定義します最後にentities(matching:) を実装して検索を実行しますクエリプロパティは Appインテントがこのクエリに関連するエンティティで検索できるあらゆる方法を表示しますエンティティのプロパティとそのプロパティで利用可能な比較演算子含む等しい小なりなどがリストに表示されていますここでは日付プロパティに「小なり」「大なり」の比較演算子をタイトルプロパティに「含む」「等しい」の比較演算子をリストに表示していますクエリプロパティはプロパティと比較演算子の各組み合わせを比較演算子マッピング型という任意の型にマッピングします CoreDataを使用しているため NSPredicateを使用しますカスタムデータベースまたは REST APIを使用した場合自身の比較演算子型を設計してそれを代用することも可能ですこちらが本のクエリプロパティを設定するコードです BooksQueryをEntityProperty Queryプロトコルに適合させます QueryPropertiesの Resultビルダーを使って staticなvarプロパティを実装します各エントリでは問い合わせ可能な PropertyのkeyPathを特定しその中でそのプロパティに適用可能な各比較演算子を指定します比較演算子のマッピング型として NSPredicateを選んだためそれぞれの比較演算子に対し NSPredicateを提供しますシステムがAppにクエリの結果を返すように要求するとここで構築している NSPredicatesが返されることになりますソートにも類似した定義がありますこれは私のモデルが本を並べ替えることができるすべてのプロパティのリストですこの場合タイトル読書日公開日でソートできるようにしています最後にデータベースにクエリを実行してエンティティのマッチングを返す entity(matching:)を実装しますこのメソッドは先に定義したクエリパラメータで使った比較演算子マッピング型の配列この場合NSPredicate を受け取りますこれらのPredicateはエンティティのプロパティのどのような基準でクエリを実行したいか示しています「and」と「or」のどちらで Predicateを組み合わせるかを示すモードソートするキーパスオプションで結果数の制限を示すことができます実装することでこれらのパラメータを使用して CoreDataデータベースに対してクエリを実行しますこのプロパティクエリで何をすることができるでしょうかライブラリからランダムに本を選んで読むことができます 20世紀初頭に出版された彼らの本をすべて見つけることができますショートカットエコシステムを活用し他のAppと連携させ Appをより便利なものにできます例えば表計算Appを使用して今年読んだ本をすべて CSVファイルに書き出すことができますグラフAppを使用して過去10年間毎年何冊の本を読んだかをグラフにすることもできますこれはほんの始まりに過ぎませんこのような Appインテントの深い導入により顧客はAppを使用して必要なことを行うことができワークフローの重要な一部となります例えばグラフの作成などこれらの統合はそれぞれ自身で構築する必要のない機能ですインテントが実行された際に Appで結果を表示したり話したり Siriのリクエストやショートカットなど曖昧さを解決するためにユーザーとのインタラクションが必要になる場合があります Appインテントは次のようなインタラクションに数多く対応していますインテント完了時にユーザーにテキストや音声でフィードバックを取得するダイアログやビジュアルフィードバックを提供するスニペットなどですインテントのパラメータの値を明確にするためのユーザーに求める要求値および曖昧性解消トランザクション的または破壊的なインテントでパラメータ値の検証またはユーザーとの確認を行う確認がありますダイアログはインテントを実行する人に対して音声またはテキストによる応答を提供します音声による体験でインテントをうまく機能させるにはダイアログを用意することがとても重要です先ほどの AddBookインテントに本のタイトルを尋ねるときに発言する needsValueDialogと performメソッドから戻されるResultダイアログを追加します複数のプラットフォームを通してショートカットやSiriによって読み取られたり表示されたりしますスニペットはダイアログの視覚的な表現となりインテントの結果に視覚的な表現を追加することができますスニペットを使用するにはインテントの結果にtrailing closureとして選択したSwiftUIビューを追加するだけですウィジェットのように SwiftUIビューはアーカイブされショートカットやSiriにアーカイブされ送信されます Appインテントは requestValueを投げてユーザーに値を要求することもサポートします例えばオプションになることもあるパラメータに値が必要な場合に便利ですここでrequestValueは文字列検索で複数の本が返ってきたときに役立ちますこの場合本の検索を絞り込むために著者で検索します requestValueでthrowができるエラーがあるためそれによりユーザーにプロンプトをし著者名を更新してアクションを返します曖昧性解消は一方でパラメータの値のセットからユーザーが選択する必要がある際に機能しますこれによりAddBookアクションで複数の可能性のある結果を処理する方法がさらに改善されましたここでは生成された本から著者名のリストを取得しそれらの可能性のある値において曖昧性解消をリクエストしますユーザーはこれらの中から選択することを要求され結果を返しますそしてAppインテントは異なる 2つの確認をサポートします１つ目はパラメータ値の確認ですこの値はその値であるべきと推測された値ですが念のため確認します本を追加する際タイトルで本を探すために呼び出した Webサービスが2件ほど適合するものを返しますがそのうちの1件が圧倒的に人気がある場合がありますこのような場合ユーザーはその人気のある本を追加したはずですが念のため間違っていないか確認をしますそのためにタイトルパラメータに requestConfirmation を呼び出します 2つ目はインテントの結果の確認ですこれはたとえば注文するときなどに最適です読書Appをマネタイズしてストアを介した注文を追加したい場合注文が間違っていないか確認したいかと思いますそのためにインテントで requestConfirmationを呼び出し注文を送信しますこちらもスニペットを指定して注文のプレビューを表示します requestConfirmationはユーザーが確認せずにキャンセルした場合エラーを投げるため呼び出しに「try」がついていますこのセッションを終える前にフレームワークを採用する際に知っておくべきいくつかの Appインテントのアーキテクチャの側面について説明したいと思います Appインテントを構築する方法には App内とそれとは別のExtensionの 2つがありますこれらのうち Appに直接インテントを実装することが最もシンプルな方法ですフレームワークやコードの複製が不要であり処理過程においても調整等が必要ないため優れた方法です Appを使うことでより高いメモリ制限とオーディオの再生など Extensionでは難しい種類の作業を行うことができますインテントにopenAppWhenRunを実装してtrueを返す場合フォアグラウンドで Appを実行することができますそうでない場合はバックグラウンドで実行されますバックグラウンドで実行する場合性能を最大化するためにシーンがない特別モードで Appが起動されます実際にAppにバックグラウンド Appインテントを実装する場合シーンのサポートも実装することを強く推奨しますまたは ExtentionでAppインテントを構築することも可能ですこれには2つほど利点があります ExtensionはAppインテントを処理するだけで Appをロードする必要がないため軽量です Focusインテントを処理する場合 Extensionを使用すると集中モードが変更された際に Appがフォアグラウンドで実行することなしに Extensionで実行されるインテントをすぐに取得できます Extensionは新しいターゲットを追加しいくつかのコードをフレームワークに移動し AppとExtension間の調整する必要があるため少し処理が必要となります App Intents Extension を作成するには Xcodeの File > New Targetから App Intents Extension を選択します Appインテントではコードが唯一のソースとなります Appインテントは構築時にインテントエンティティクエリパラメータに関する情報を静的に抽出することでこの素晴らしいデベロッパ体験を実現します Xcodeは構築中にコード上で実行する際に Swiftコンパイラから受け取った情報を含め AppまたはExtension バンドルの内部にメタデータファイルを生成しますこのすべてが機能させるには App Intents型をフレームワークではなくターゲットまたは Extensionに直接保持するようにしますローカライズされた文字列は App Intents型が存在するのと同じバンドル内の stringsファイルに入れます SiriKitインテントを搭載した既存のAppをお持ちの方でバージョンアップしたい方ウィジェットとの連携やメッセージングやメディアなどの領域にインテントを採用する場合は SiriKit Intentsフレームワークを使い続ける必要があります Siriとショートカットにカスタムインテントを追加する場合は先にAppインテントにアップグレードしておくと良いでしょう SiriKitのインテント定義ファイルにある Convert to App Intentボタンをクリックするとアップグレード処理を開始することができます AppをAppインテントを使ったショートカットに対応させることはデベロッパとしてのレバレッジを最大化するための素晴らしい方法です Appインテントを採用するための少しの作業を行うだけで大きな価値を生み出すことができるからですご視聴いただきありがとうございます今日からAppインテントをお試しいただき皆さまのご意見をいただければと思いますこの新しいフレームワークが Appを使う人たちに驚きや喜び力を与えるのに役立つことを願います WWDCで素晴らしい時間と読書を楽しんでください！ ♪

struct OpenCurrentlyReading: AppIntent {
    static var title: LocalizedStringResource = "Open Currently Reading"

    @MainActor
    func perform() async throws -> some IntentResult {
        Navigator.shared.openShelf(.currentlyReading)
        return .result()
    }
  
    static var openAppWhenRun: Bool = true
}

6:42 - App Shortcuts

struct LibraryAppShortcuts: AppShortcutsProvider {
    static var appShortcuts: [AppShortcut] {
        AppShortcut(
            intent: OpenCurrentlyReading(),
            phrases: ["Open Currently Reading in \(.applicationName)"],
            systemImageName: "books.vertical.fill"
        )
    }
}

7:11 - Shelf Enum

enum Shelf: String {
    case currentlyReading
    case wantToRead
    case read
}

extension Shelf: AppEnum {
    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Shelf"

    static var caseDisplayRepresentations: [Shelf: DisplayRepresentation] = [
        .currentlyReading: "Currently Reading",
        .wantToRead: "Want to Read",
        .read: "Read",
    ]
}

7:49 - Open Shelf

struct OpenShelf: AppIntent {
    static var title: LocalizedStringResource = "Open Shelf"

    @Parameter(title: "Shelf")
    var shelf: Shelf

    @MainActor
    func perform() async throws -> some IntentResult {
        Navigator.shared.openShelf(shelf)
        return .result()
    }

    static var parameterSummary: some ParameterSummary {
        Summary("Open \(\.$shelf)")
    }

    static var openAppWhenRun: Bool = true
}

10:56 - Book Entity

struct BookEntity: AppEntity, Identifiable {
    var id: UUID

    var displayRepresentation: DisplayRepresentation { "\(title)" }

    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Book"

    static var defaultQuery = BookQuery()
}

12:29 - Book Query

struct BookQuery: EntityQuery {
    func entities(for identifiers: [UUID]) async throws -> [BookEntity] {
        identifiers.compactMap { identifier in
            Database.shared.book(for: identifier)
        }
    }
}

13:16 - Open Book

struct OpenBook: AppIntent {
    @Parameter(title: "Book")
    var book: BookEntity

    static var title: LocalizedStringResource = "Open Book"

    static var openAppWhenRun = true

    @MainActor
    func perform() async throws -> some IntentResult {
        guard try await $book.requestConfirmation(for: book, dialog: "Are you sure you want to clear read state for \(book)?") else {
            return .result()
        }
        Navigator.shared.openBook(book)
        return .result()
    }

    static var parameterSummary: some ParameterSummary {
        Summary("Open \(\.$book)")
    }
  
    init() {}

    init(book: BookEntity) {
        self.book = book
    }
}

struct BookQuery: EntityStringQuery {
    func entities(for identifiers: [UUID]) async throws -> [BookEntity] {
        identifiers.compactMap { identifier in
            Database.shared.book(for: identifier)
        }
    }

    func suggestedEntities() async throws -> [BookEntity] {
        Database.shared.books
    }

    func entities(matching string: String) async throws -> [BookEntity] {
        Database.shared.books.filter { book in
            book.title.lowercased().contains(string.lowercased())
        }
    }
}

15:11 - Add Book Intent

struct AddBook: AppIntent {
    static var title: LocalizedStringResource = "Add Book"

    @Parameter(title: "Title")
    var title: String

    @Parameter(title: "Author Name")
    var authorName: String?

    @Parameter(title: "Recommended By")
    var recommendedBy: String?

    func perform() async throws -> some IntentResult & ReturnsValue<BookEntity> & OpensIntent {
        guard var book = await BooksAPI.shared.findBooks(named: title, author: authorName).first else {
            throw Error.notFound
        }
        book.recommendedBy = recommendedBy
        Database.shared.add(book: book)

        return .result(
            value: book,
            openIntent: OpenBook(book: book)
        )
    }

    enum Error: Swift.Error, CustomLocalizedStringResourceConvertible {
        case notFound

        var localizedStringResource: LocalizedStringResource {
            switch self {
                case .notFound: return "Book Not Found"
            }
        }
    }
}

18:21 - Book Entity with Properties

struct BookEntity: AppEntity, Identifiable {
    var id: UUID

    @Property(title: "Title")
    var title: String

    @Property(title: "Publishing Date")
    var datePublished: Date

    @Property(title: "Read Date")
    var dateRead: Date?

    var recommendedBy: String?

    var displayRepresentation: DisplayRepresentation { "\(title)" }

    static var typeDisplayRepresentation: TypeDisplayRepresentation = "Book"

    static var defaultQuery = BookQuery()

    init(id: UUID) {
        self.id = id
    }

    init(id: UUID, title: String) {
        self.id = id
        self.title = title
    }
}

20:59 - Books Property Query

struct BookQuery: EntityPropertyQuery {
    static var sortingOptions = SortingOptions {
        SortableBy(\BookEntity.$title)
        SortableBy(\BookEntity.$dateRead)
        SortableBy(\BookEntity.$datePublished)
    }

    static var properties = QueryProperties {
        Property(\BookEntity.$title) {
            EqualToComparator { NSPredicate(format: "title = %@", $0) }
            ContainsComparator { NSPredicate(format: "title CONTAINS %@", $0) }
        }
        Property(\BookEntity.$datePublished) {
            LessThanComparator { NSPredicate(format: "datePublished < %@", $0 as NSDate) }
            GreaterThanComparator { NSPredicate(format: "datePublished > %@", $0 as NSDate) }
        }
        Property(\BookEntity.$dateRead) {
            LessThanComparator { NSPredicate(format: "dateRead < %@", $0 as NSDate) }
            GreaterThanComparator { NSPredicate(format: "dateRead > %@", $0 as NSDate) }
        }
    }

    func entities(for identifiers: [UUID]) async throws -> [BookEntity] {
        identifiers.compactMap { identifier in
            Database.shared.book(for: identifier)
        }
    }

    func suggestedEntities() async throws -> [BookEntity] {
        Model.shared.library.books.map { BookEntity(id: $0.id, title: $0.title) }
    }

    func entities(matching string: String) async throws -> [BookEntity] {
        Database.shared.books.filter { book in
            book.title.lowercased().contains(string.lowercased())
        }
    }

    func entities(
        matching comparators: [NSPredicate],
        mode: ComparatorMode,
        sortedBy: [Sort<BookEntity>],
        limit: Int?
    ) async throws -> [BookEntity] {
        Database.shared.findBooks(matching: comparators, matchAll: mode == .and, sorts: sortedBy.map { (keyPath: $0.by, ascending: $0.order == .ascending) })
    }
}

24:10 - Dialog

struct AddBook: AppIntent {
    static var title: LocalizedStringResource = "Add Book"

    @Parameter(title: "Title")
    var title: String

    @Parameter(title: "Author Name")
    var authorName: String?

    @Parameter(title: "Recommended By")
    var recommendedBy: String?

    func perform() async throws -> some IntentResult & ReturnsValue<BookEntity> & ProvidesDialog {
        guard var book = await BooksAPI.shared.findBooks(named: title, author: authorName).first else {
            throw Error.notFound
        }
        book.recommendedBy = recommendedBy
        Database.shared.add(book: book)

        return .result(
            value: book,
            dialog:"Added \(book) to Library!"
        )
    }

    enum Error: Swift.Error, CustomLocalizedStringResourceConvertible {
        case notFound

        var localizedStringResource: LocalizedStringResource {
            switch self {
                case .notFound: return "Book Not Found"
            }
        }
    }
}

24:25 - Snippet

struct AddBook: AppIntent {
    static var title: LocalizedStringResource = "Add Book"

    @Parameter(title: "Title")
    var title: String

    @Parameter(title: "Author Name")
    var authorName: String?

    @Parameter(title: "Recommended By")
    var recommendedBy: String?

    func perform() async throws -> some IntentResult & ShowsSnippetView {
        guard var book = await BooksAPI.shared.findBooks(named: title, author: authorName).first else {
            throw Error.notFound
        }
        book.recommendedBy = recommendedBy
        Database.shared.add(book: book)

        return .result(value: book) {
            CoverView(book: book)
        }
    }

    enum Error: Swift.Error, CustomLocalizedStringResourceConvertible {
        case notFound

        var localizedStringResource: LocalizedStringResource {
            switch self {
                case .notFound: return "Book Not Found"
            }
        }
    }
}

24:50 - Request Value

struct AddBook: AppIntent {
    static var title: LocalizedStringResource = "Add Book"

    @Parameter(title: "Title")
    var title: String

    @Parameter(title: "Author Name")
    var authorName: String?

    @Parameter(title: "Recommended By")
    var recommendedBy: String?

    func perform() async throws -> some IntentResult {
        let books = await BooksAPI.shared.findBooks(named: title, author: authorName)
        guard !books.isEmpty else {
            throw Error.notFound
        }
        if books.count > 1 && authorName == nil {
            throw $authorName.requestValue("Who wrote the book?")
        }

        return .result()
    }

    enum Error: Swift.Error, CustomLocalizedStringResourceConvertible {
        case notFound

        var localizedStringResource: LocalizedStringResource {
            switch self {
                case .notFound: return "Book Not Found"
            }
        }
    }
}

25:22 - Request Disambiguation

struct AddBook: AppIntent {
    static var title: LocalizedStringResource = "Add Book"

    @Parameter(title: "Title")
    var title: String

    @Parameter(title: "Author Name")
    var authorName: String?

    @Parameter(title: "Recommended By")
    var recommendedBy: String?

    func perform() async throws -> some IntentResult {
        let books = await BooksAPI.shared.findBooks(named: title, author: authorName)
        guard !books.isEmpty else {
            throw Error.notFound
        }
        if books.count > 1 {
            let chosenAuthor = try await $authorName.requestDisambiguation(among: books.map { $0.authorName }, dialog: "Which author?")
        }
        return .result()
    }

    enum Error: Swift.Error, CustomLocalizedStringResourceConvertible {
        case notFound

        var localizedStringResource: LocalizedStringResource {
            switch self {
                case .notFound: return "Book Not Found"
            }
        }
    }
}

25:48 - Request Parameter Confirmation

struct AddBook: AppIntent {
    static var title: LocalizedStringResource = "Add Book"

    @Parameter(title: "Title")
    var title: String

    @Parameter(title: "Author Name")
    var authorName: String?

    @Parameter(title: "Recommended By")
    var recommendedBy: String?

    func perform() async throws -> some IntentResult & ReturnsValue<BookEntity> {
        guard var book = await BooksAPI.shared.findBooks(named: title, author: authorName).first else {
            throw Error.notFound
        }
        let confirmed = try await $title.requestConfirmation(for: book.title, dialog: "Did you mean \(book)?")
        book.recommendedBy = recommendedBy
        Database.shared.add(book: book)
        return .result(value: book)
    }

    enum Error: Swift.Error, CustomLocalizedStringResourceConvertible {
        case notFound

        var localizedStringResource: LocalizedStringResource {
            switch self {
                case .notFound: return "Book Not Found"
            }
        }
    }
}

26:26 - Request Result Confirmation

struct BuyBook: AppIntent {
    @Parameter(title: "Book")
    var book: BookEntity

    @Parameter(title: "Count")
    var count: Int

    static var title: LocalizedStringResource = "Buy Book"

    func perform() async throws -> some IntentResult & ShowsSnippetView & ProvidesDialog {
        let order = OrderEntity(book: book, count: count)
        try await requestConfirmation(output: .result(value: order, dialog: "Are you ready to order?") {
            OrderPreview(order: order)
        })

        return .result(value: order, dialog: "Thank you for your order!") {
            OrderConfirmation(order: order)
        }
    }
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC23

Tech Talks

WWDC22

WWDC21