Xamarin.iOS での SiriKit の実装

[アーティクル]
07/13/2023

この記事では、Xamarin.iOS アプリで SiriKit サポートを実装するために必要な手順について説明します。

iOS 10 の新機能である SiriKit を使用すると、Xamarin.iOS アプリは、Siri と iOS デバイス上の Maps アプリを使用してユーザーがアクセスできるサービスを提供できます。この記事では、Xamarin.iOS アプリで SiriKit サポートを実装するために必要な手順について説明します。これには、必要な意図拡張機能、意図 UI 拡張機能、ボキャブラリを追加します。

Siri は、関連するタスクの既知のアクションのグループ であるドメインの概念に対応しています。アプリが Siri とやり取りするたびに、次のように既知のサービスドメインのいずれかに分類される必要があります。

オーディオまたはビデオ通話。
乗車を予約する。
ワークアウトの管理。
メッセージング。
写真の検索。
支払いの送受信。

ユーザーがアプリ拡張機能のサービスの 1 つに関係する Siri の要求を行うと、SiriKit は拡張機能に、ユーザーの要求とサポートデータを記述する Intent オブジェクトを送信します。その後、アプリ拡張機能は、指定された意図に対して適切な Response オブジェクトを生成し、拡張機能が要求を処理する方法を詳しく説明します。

このガイドでは、SiriKit のサポートを既存のアプリに含む簡単な例を紹介します。この例のために、偽の MonkeyChat アプリを使用します。

MonkeyChat は、ユーザーの友人の独自の連絡先ブックを保持し、それぞれが画面名 (Bobo など) に関連付け、ユーザーが画面名で各友人にテキストチャットを送信できるようにします。

SiriKit を使用したアプリの拡張

「SiriKit の概念を理解する」ガイドに示すように、SiriKit を使用したアプリの拡張には、次の 3 つのメイン部分があります。

これには以下が含まれます。

意図拡張機能 - ユーザーの応答を検証し、アプリが要求を処理できることを確認し、ユーザーの要求を満たすためにタスクを実際に実行します。
意図 UI 拡張機能 - オプション。Siri 環境の応答にカスタム UI を提供し、アプリの UI とブランド化を Siri に取り込んで、ユーザーのエクスペリエンスを強化できます。
アプリ - Siri の操作を支援するために、ユーザー固有の語彙をアプリに提供します。

これらの要素とアプリに含める手順については、以下のセクションで詳しく説明します。

アプリの準備

SiriKit は拡張機能に基づいて構築されていますが、拡張機能をアプリに追加する前に、開発者が SiriKit の導入に役立ついくつかの作業を行う必要があります。

共通共有コードの移動

最初に、開発者は、アプリと拡張機能の間で共有される一般的なコードの一部を 、共有プロジェクト、 ポータブルクラスライブラリ (PCL) または ネイティブライブラリのいずれかに移動できます。

拡張機能は、アプリが行うすべての操作を実行できる必要があります。サンプルの MonkeyChat アプリでは、連絡先の検索、新しい連絡先の追加、メッセージの送信、メッセージ履歴の取得などが含まれます。

この共通コードを共有プロジェクト、PCL、またはネイティブライブラリに移動することで、そのコードを 1 つの共通の場所に簡単に維持でき、拡張機能と親アプリがユーザーに統一されたエクスペリエンスと機能を提供できるようになります。

サンプルアプリの MonkeyChat の場合、ネットワークやデータベースへのアクセスなどのデータモデルと処理コードはネイティブライブラリに移動されます。

次の操作を行います。

Visual Studio for Mac
Visual Studio

Visual Studio for Macを起動し、MonkeyChat アプリを開きます。
Solution Pad でソリューション名を右クリックし、[新しいプロジェクトの追加]> を選択します。
[ iOS>ライブラリ>クラスライブラリ ] を選択し、[ 次へ ] ボタンをクリックします。
[名前] に「」と入力MonkeyChatCommonし、[作成] ボタンをクリックします。
ソリューションエクスプローラーでメインアプリの References フォルダーを右クリックし、[参照の編集]を選択します。MonkeyChatCommon プロジェクトを確認し、[OK] ボタンをクリックします。
ソリューションエクスプローラーで、共通の共有コードをメインアプリからネイティブライブラリにドラッグします。
MonkeyChat の場合は、dataModels フォルダーと Processors フォルダーをメインアプリからネイティブライブラリにドラッグします。

Visual Studio を起動し、MonkeyChat アプリを開きます。
ソリューションエクスプローラーでソリューション名を右クリックし、[新しいプロジェクトの追加>]を選択します。
[ Visual C#>共有プロジェクト ] を選択し、[ 次へ ] ボタンをクリックします。
[名前] に「」と入力MonkeyChatCommonし、[作成] ボタンをクリックします。
ソリューションエクスプローラーでメインアプリの References フォルダーを右クリックし、[参照の編集]を選択します。MonkeyChatCommon プロジェクトを確認し、[OK] ボタンをクリックします。
ソリューションエクスプローラーで、共通の共有コードをメインアプリから共有プロジェクトにドラッグします。
MonkeyChat の場合は、dataModels フォルダーと Processors フォルダーをメインアプリからネイティブライブラリにドラッグします。

ネイティブライブラリに移動されたすべてのファイルを編集し、ライブラリの名前空間と一致するように名前空間を変更します。たとえば、をに変更 MonkeyChat します MonkeyChatCommon。

using System;
namespace MonkeyChatCommon
{
    /// <summary>
    /// A message sent from one user to another within a conversation.
    /// </summary>
    public class MonkeyMessage
    {
        public MonkeyMessage ()
        {
        }
        ...
    }
}

次に、メインアプリに戻り、移動されたクラスの 1 つをアプリが使用する任意の場所に、ネイティブライブラリの名前空間のステートメントを追加usingします。

using System;
using System.Collections.Generic;
using UIKit;
using Foundation;
using CoreGraphics;
using MonkeyChatCommon;

namespace MonkeyChat
{
    public partial class MasterViewController : UITableViewController
    {
        public DetailViewController DetailViewController { get; set; }

        DataSource dataSource;
        ...
    }
}

拡張機能用アプリの設計

通常、アプリは複数の意図にサインアップし、開発者はアプリが適切な数の意図拡張機能用に設計されていることを確認する必要があります。

アプリに複数の意図が必要な場合、開発者は、すべての意図処理を 1 つの意図拡張機能に配置するか、意図ごとに個別の意図拡張機能を作成することができます。

意図ごとに個別の意図拡張機能を作成する場合、開発者は各拡張機能で大量の定型コードを複製し、大量のプロセッサとメモリのオーバーヘッドを作成する可能性があります。

2 つのオプションを選択するには、いずれかの意図が自然に一緒に属しているかどうかを確認します。たとえば、オーディオ呼び出しとビデオ呼び出しを行ったアプリでは、似たタスクを処理しており、コードの再利用が最も多い可能性があるため、これらの意図の両方を 1 つの意図拡張機能に含める必要がある場合があります。

既存のグループに収まらない意図または意図のグループについては、アプリのソリューションに新しい意図拡張機能を作成して含めます。

必須エンタイトルメントの設定

SiriKit 統合を含む Xamarin.iOS アプリには、正しいエンタイトルメントが設定されている必要があります。開発者がこれらの必須エンタイトルメントを正しく設定していない場合、iOS 10 シミュレーターでは SiriKit がサポートされていないため、実際の iOS 10 (またはそれ以上) のハードウェアでアプリをインストールまたはテストすることはできません。

次の操作を行います。

Visual Studio for Mac
Visual Studio

ソリューションエクスプローラー内のファイルをダブルクリックEntitlements.plistして、編集用に開きます。
[ソース] タブに切り替えます。
プロパティを追加しcom.apple.developer.siri、Type をにBoolean、Value をにYes設定します。
変更をファイルに保存します。
ソリューションエクスプローラーの [プロジェクトファイル] をダブルクリックして、編集用に開きます。
[iOS バンドル署名] を選択し、[カスタムエンタイトルメント] フィールドでファイルが選択されていることを確認Entitlements.plistします。
[OK] ボタンをクリックして、変更を保存します。

ソリューションエクスプローラー内のファイルをダブルクリックEntitlements.plistして、編集用に開きます。
プロパティを追加しcom.apple.developer.siri、Type をにBoolean、Value をにYes設定します。
変更をファイルに保存します。
ソリューションエクスプローラーの [プロジェクトファイル] をダブルクリックして、編集用に開きます。
[iOS バンドル署名] を選択し、[カスタムエンタイトルメント] フィールドでファイルが選択されていることを確認Entitlements.plistします。

完了すると、アプリの Entitlements.plist ファイルは次のようになります (外部エディターで開かれています)。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>com.apple.developer.siri</key>
    <true/>
</dict>
</plist>

アプリの正しいプロビジョニング

Apple が SiriKit フレームワークの周りに配置した厳格なセキュリティのため、SiriKit を実装する Xamarin.iOS アプリには、正しいアプリ ID とエンタイトルメント (上記のセクションを参照) が必要であり、適切なプロビジョニングプロファイルで署名する必要があります。

Mac で次の操作を行います。

Web ブラウザーで、に移動し https://developer.apple.com 、アカウントにログインします。
[証明書、識別子、およびプロファイル] をクリックします。
[ プロビジョニングプロファイル] を選択し、[ アプリ ID] を選択し、ボタンを + クリックします。
新しいプロファイルの名前を入力 します 。
Apple の名前付けの推奨事項に従って 、バンドル ID を 入力します。
[App Services] セクションまで下にスクロールし、[SiriKit] を選択し、[続行] ボタンをクリックします。
すべての設定を確認し、アプリ ID を送信します。
[プロビジョニングプロファイル開発]> を選択し、ボタンを+クリックし、Apple ID を選択して、[続行] をクリックします。
[ すべて選択] をクリックし、[ 続行] をクリックします。
[ すべて選択 ] をもう一度クリックし、[ 続行] をクリックします。
Apple の名前付け候補を使用して プロファイル名 を入力し、[ 続行] をクリックします。
Xcode を起動します。
[Xcode] メニューの [ 基本設定] を選択します。
[ アカウント] を選択し、[ 詳細の表示 ]ボタンをクリックします。
左下隅 にある [すべてのプロファイルのダウンロード ] ボタンをクリックします。
上記で作成した プロビジョニングプロファイル が Xcode にインストールされていることを確認します。
プロジェクトを開き、Visual Studio for Macで SiriKit サポートをに追加します。
ソリューションエクスプローラー内のファイルをダブルクリックしますInfo.plist。
バンドル識別子が、上記の Apple の開発者ポータルで作成されたものと一致していることを確認します。
ソリューションエクスプローラーで、[プロジェクト] を選択します。
プロジェクトを右クリックし、[ オプション] を選択します。
[ iOS バンドル署名] を選択し、上記で作成した 署名 ID と プロビジョニングプロファイルを 選択します。
[OK] ボタンをクリックして、変更を保存します。

重要

SiriKit のテストは、iOS 10 シミュレーターではなく、実際の iOS 10 ハードウェアデバイスでのみ機能します。 SiriKit 対応 Xamarin.iOS アプリを実際のハードウェアにインストールする際に問題が発生した場合は、Apple の開発者ポータルとVisual Studio for Macの両方で、必要なエンタイトルメント、アプリ ID、署名識別子、プロビジョニングプロファイルが正しく構成されていることを確認します。

Siri 承認の要求

アプリがユーザー固有のボキャブラリまたは意図拡張機能を Siri に接続する前に、Siri にアクセスするための承認をユーザーに要求する必要があります。

Visual Studio for Mac
Visual Studio

アプリの Info.plist ファイルを編集し、[ ソース ] ビューに切り替え、アプリで Siri を使用する方法と送信されるデータの種類を説明する文字列値を含むキーを追加 NSSiriUsageDescription します。たとえば、MonkeyChat アプリに "MonkeyChat 連絡先が Siri に送信されます" と表示される場合があります。

アプリの RequestSiriAuthorization 初回起動時に INPreferences クラスのメソッドを呼び出します。クラスを AppDelegate.cs 編集し、メソッドを FinishedLaunching 次のようにします。

using Intents;
...

public override bool FinishedLaunching (UIApplication application, NSDictionary launchOptions)
{

    // Request access to Siri
    INPreferences.RequestSiriAuthorization ((INSiriAuthorizationStatus status) => {
        // Respond to returned status
        switch (status) {
        case INSiriAuthorizationStatus.Authorized:
            break;
        case INSiriAuthorizationStatus.Denied:
            break;
        case INSiriAuthorizationStatus.NotDetermined:
            break;
        case INSiriAuthorizationStatus.Restricted:
            break;
        }
    });

    return true;
}

このメソッドが初めて呼び出されると、アプリが Siri にアクセスすることをユーザーに求める警告が表示されます。開発者が上記に NSSiriUsageDescription 追加したメッセージは、このアラートに表示されます。ユーザーが最初にアクセスを拒否した場合は、設定アプリを使用してアプリへのアクセスを許可できます。

アプリは、クラスのメソッドを呼び出すことによって、いつでも Siri にアクセスするアプリの機能をSiriAuthorizationStatusINPreferencesチェックできます。

ローカリゼーションと Siri

iOS デバイスでは、ユーザーは、システムの既定値とは異なる Siri の言語を選択できます。ローカライズされたデータを操作する場合、アプリはクラスの INPreferences メソッドをSiriLanguageCode使用して Siri から言語コードを取得する必要があります。次に例を示します。

var language = INPreferences.SiriLanguageCode();

// Take action based on language
if (language == "en-US") {
    // Do something...
}

ユーザー固有のボキャブラリの追加

ユーザー固有のボキャブラリは、アプリの個々のユーザーに固有の単語またはフレーズを提供します。これらは、実行時にメインアプリから (App Extensions ではなく) 順序付けされた一連の用語として提供され、ユーザーにとって最も重要な使用優先順位で並べ替えられます。最も重要な用語は一覧の先頭に表示されます。

ユーザー固有のボキャブラリは、次のいずれかのカテゴリに属している必要があります。

連絡先名 (連絡先フレームワークによって管理されない)。
写真タグ。
フォトアルバム名。
ワークアウト名。

カスタムボキャブラリとして登録する用語を選択する場合は、アプリに慣れていないユーザーによって誤解される可能性がある用語のみを選択します。 "マイワークアウト" や "マイアルバム" などの一般的な用語を登録しないでください。たとえば、MonkeyChat アプリは、ユーザーのアドレス帳の各連絡先に関連付けられているニックネームを登録します。

アプリは、クラスのメソッドINVocabularyをSetVocabularyStrings呼び出し、メインアプリからコレクションをNSOrderedSet渡すことによって、ユーザー固有のボキャブラリを提供します。アプリでは、新しい用語を追加する前に既存の RemoveAllVocabularyStrings 用語を削除するために、常に最初にメソッドを呼び出す必要があります。次に例を示します。

using System;
using System.Linq;
using System.Collections.Generic;
using Foundation;
using Intents;

namespace MonkeyChatCommon
{
    public class MonkeyAddressBook : NSObject
    {
        #region Computed Properties
        public List<MonkeyContact> Contacts { get; set; } = new List<MonkeyContact> ();
        #endregion

        #region Constructors
        public MonkeyAddressBook ()
        {
        }
        #endregion

        #region Public Methods
        public NSOrderedSet<NSString> ContactNicknames ()
        {
            var nicknames = new NSMutableOrderedSet<NSString> ();

            // Sort contacts by the last time used
            var query = Contacts.OrderBy (contact => contact.LastCalledOn);

            // Assemble ordered list of nicknames by most used to least
            foreach (MonkeyContact contact in query) {
                nicknames.Add (new NSString (contact.ScreenName));
            }

            // Return names
            return new NSOrderedSet<NSString> (nicknames.AsSet ());
        }

        // This method MUST only be called on a background thread!
        public void UpdateUserSpecificVocabulary ()
        {
            // Clear any existing vocabulary
            INVocabulary.SharedVocabulary.RemoveAllVocabularyStrings ();

            // Register new vocabulary
            INVocabulary.SharedVocabulary.SetVocabularyStrings (ContactNicknames (), INVocabularyStringType.ContactName);
        }
        #endregion
    }
}

このコードを配置すると、次のように呼び出される場合があります。

using System;
using System.Threading;
using UIKit;
using MonkeyChatCommon;
using Intents;

namespace MonkeyChat
{
    public partial class ViewController : UIViewController
    {
        #region AppDelegate Access
        public AppDelegate ThisApp {
            get { return (AppDelegate)UIApplication.SharedApplication.Delegate; }
        }
        #endregion

        #region Constructors
        protected ViewController (IntPtr handle) : base (handle)
        {
            // Note: this .ctor should not contain any initialization logic.
        }
        #endregion

        #region Override Methods
        public override void ViewDidLoad ()
        {
            base.ViewDidLoad ();

            // Do we have access to Siri?
            if (INPreferences.SiriAuthorizationStatus == INSiriAuthorizationStatus.Authorized) {
                // Yes, update Siri's vocabulary
                new Thread (() => {
                    Thread.CurrentThread.IsBackground = true;
                    ThisApp.AddressBook.UpdateUserSpecificVocabulary ();
                }).Start ();
            }
        }

        public override void DidReceiveMemoryWarning ()
        {
            base.DidReceiveMemoryWarning ();
            // Release any cached data, images, etc that aren't in use.
        }
        #endregion
    }
}

重要

Siri はカスタムボキャブラリをヒントとして扱い、できるだけ多くの用語を組み込みます。ただし、カスタムボキャブラリの領域は限られているため、混乱を招く可能性のある用語 のみを 登録することが重要であるため、登録された用語の合計数を最小限に抑える必要があります。

詳細については、ユーザー固有のボキャブラリリファレンスと Apple のカスタムボキャブラリリファレンスの指定に関するページを参照してください。

アプリ固有のボキャブラリの追加

アプリ固有のボキャブラリは、車両の種類やワークアウト名など、アプリのすべてのユーザーに認識される特定の単語とフレーズを定義します。これらはアプリケーションの一部であるため、メインアプリバンドルの一部としてファイルでAppIntentVocabulary.plist定義されます。さらに、これらの単語と語句をローカライズする必要があります。

アプリ固有のボキャブラリ用語は、次のいずれかのカテゴリに属している必要があります。

乗車オプション。
ワークアウト名。

アプリ固有のボキャブラリファイルには、次の 2 つのルートレベルキーが含まれています。

ParameterVocabularies必須 - 適用するアプリのカスタム用語と意図パラメーターを定義します。
IntentPhrases省略可能 - で定義されているカスタム用語を使用したフレーズの例が ParameterVocabularies含まれます。

内 ParameterVocabularies の各エントリでは、ID 文字列、用語、および用語が適用される意図を指定する必要があります。さらに、1 つの用語が複数の意図に適用される場合があります。

許容される値と必要なファイル構造の完全な一覧については、「Apple のアプリボキャブラリファイル形式リファレンス」を参照してください。

アプリプロジェクトにファイルを AppIntentVocabulary.plist 追加するには、次の操作を行います。

Visual Studio for Mac
Visual Studio

ソリューションエクスプローラーで [プロジェクト名] を右クリックし、[新しいファイルの追加]>を選択します。>iOS:
ソリューションエクスプローラー内のファイルをダブルクリックAppIntentVocabulary.plistして、編集用に開きます。
を + クリックしてキーを追加し、[ 名前] をに ParameterVocabularies 、 Type をに Array設定します。
ボタンを+展開ParameterVocabulariesしてクリックし、[種類] をにDictionary設定します。
を + クリックして新しいキーを追加し、[ 名前] をに ParameterNames 、 Type をに Array設定します。
を + クリックして、 Type がの String 新しいキーと、使用可能なパラメーター名の 1 つとして値を追加します。 INStartWorkoutIntent.workoutName の例を次に示します。
型Arrayが ParameterVocabulary のParameterVocabulariesキーにキーを追加します。
型Dictionaryがの新しいキーを追加します。
Type が VocabularyItemIdentifier のStringキーを追加し、用語の一意の ID を指定します。
型ArrayがのVocabularyItemSynonymsキーを追加します。
型Dictionaryがの新しいキーを追加します。
型String がのVocabularyItemPhraseキーと、アプリで定義されている用語を追加します。
VocabularyItemPronunciationの種類Stringと用語の発音を使用してキーを追加します。
型ArrayがのVocabularyItemExamplesキーを追加します。
用語の使用例を使用して、いくつかの String キーを追加します。
アプリで定義する必要があるその他のカスタム用語については、上記の手順を繰り返します。
キーを ParameterVocabularies 折りたたみます。
型ArrayがのIntentPhrasesキーを追加します。
型Dictionaryがの新しいキーを追加します。
次の IntentName 例の Type と String Intent を使用してキーを追加します。
型ArrayがのIntentExamplesキーを追加します。
用語の使用例を使用して、いくつかの String キーを追加します。
アプリで使用例を提供する必要がある意図について、上記の手順を繰り返します。

ソリューションエクスプローラーで [プロジェクト名] を右クリックし、[新しい項目の追加>]を選択します。 >Apple > プロパティリスト > Info.plist:
ソリューションエクスプローラー内のファイルをダブルクリックAppIntentVocabulary.plistして、編集用に開きます。
を + クリックしてキーを追加し、[ 名前] をに ParameterVocabularies 、 Type をに Array設定します。
ボタンを+展開ParameterVocabulariesしてクリックし、[種類] をにDictionary設定します。
を + クリックして新しいキーを追加し、[ 名前] をに ParameterNames 、 Type をに Array設定します。
を + クリックして、 Type がの String 新しいキーと、使用可能なパラメーター名の 1 つとして値を追加します。 INStartWorkoutIntent.workoutName の例を次に示します。
型Arrayが ParameterVocabulary のParameterVocabulariesキーにキーを追加します。
型Dictionaryがの新しいキーを追加します。
Type が VocabularyItemIdentifier のStringキーを追加し、用語の一意の ID を指定します。
型ArrayがのVocabularyItemSynonymsキーを追加します。
型Dictionaryがの新しいキーを追加します。
型String がのVocabularyItemPhraseキーと、アプリで定義されている用語を追加します。
VocabularyItemPronunciationの種類Stringと用語の発音を使用してキーを追加します。
型ArrayがのVocabularyItemExamplesキーを追加します。
用語の使用例を使用して、いくつかの String キーを追加します。
アプリで定義する必要があるその他のカスタム用語については、上記の手順を繰り返します。
キーを ParameterVocabularies 折りたたみます。
型ArrayがのIntentPhrasesキーを追加します。
型Dictionaryがの新しいキーを追加します。
次の IntentName 例の Type と String Intent を使用してキーを追加します。
型ArrayがのIntentExamplesキーを追加します。
用語の使用例を使用して、いくつかの String キーを追加します。
アプリで使用例を提供する必要がある意図について、上記の手順を繰り返します。

重要

は AppIntentVocabulary.plist 開発中にテストデバイスで Siri に登録され、Siri がカスタムボキャブラリを組み込むのに時間がかかる場合があります。その結果、テスト担当者は、更新されたアプリ固有のボキャブラリをテストする前に数分待つ必要があります。

詳細については、アプリ固有のボキャブラリリファレンスと Apple のカスタムボキャブラリリファレンスの指定に関するページを参照してください。

意図拡張機能の追加

アプリが SiriKit を採用する準備ができたので、開発者は、Siri 統合に必要な意図を処理するために、ソリューションに 1 つ (または複数) の意図拡張機能を追加する必要があります。

必要な意図拡張機能ごとに、次の操作を行います。

意図拡張機能プロジェクトを Xamarin.iOS アプリソリューションに追加します。
Intents Extension Info.plist ファイルを構成します。
Intents Extension メインクラスを変更します。

詳細については、意図拡張機能リファレンスと Apple の意図拡張機能の作成に関するリファレンスを参照してください。

拡張機能の作成

ソリューションに意図拡張機能を追加するには、次の操作を行います。

Visual Studio for Mac
Visual Studio

Solution Pad の [ソリューション名] を右クリックし、[新しいプロジェクトの追加]> を選択します。
ダイアログボックスから [ iOS>拡張機能>の意図拡張機能 ] を選択し、[ 次へ ] ボタンをクリックします。
次に、インテント拡張機能の名前を入力し、[ 次へ ] ボタンをクリックします。
最後に、[ 作成 ] ボタンをクリックして、意図拡張機能をアプリソリューションに追加します。
ソリューションエクスプローラーで、新しく作成された意図拡張機能の References フォルダーを右クリックします。共通の共有コードライブラリプロジェクト (上記で作成したアプリ) の名前を確認し、[OK] ボタンをクリック します 。

アプリに必要な意図拡張機能の数 (上記の [ 拡張機能用アプリの設計 ] セクションに基づく) に対して、これらの手順を繰り返します。

Info.plist の構成

アプリのソリューションに追加された意図拡張機能ごとに、アプリを操作するようにファイルで Info.plist を構成する必要があります。

一般的なアプリ拡張機能と同様に、アプリにはと NSExtensionAttributesの既存のNSExtensionキーが含まれます。インテント拡張機能には、次の 2 つの新しい属性を構成する必要があります。

IntentsSupported - 必須であり、アプリがインテント拡張機能からサポートする意図クラス名の配列で構成されます。
IntentsRestrictedWhileLocked - 拡張機能のロック画面の動作を指定するアプリの省略可能なキーです。これは、アプリが意図拡張機能から使用するためにユーザーのログインを要求する意図クラス名の配列で構成されます。

インテント拡張機能Info.plistのファイルを構成するには、ソリューションエクスプローラーでダブルクリックして編集用に開きます。次に、ソース ビューに切り替え、エディターでキーと NSExtensionAttributes キーを展開NSExtensionします。

Visual Studio for Mac
Visual Studio

キーを IntentsSupported 展開し、この拡張機能でサポートされるインテントクラスの名前を追加します。例の MonkeyChat アプリでは、が INSendMessageIntentサポートされています。

Visual Studio for Mac
Visual Studio

アプリで必要に応じて、特定の意図を使用するためにユーザーをデバイスにログオンさせる必要がある場合は、キーを IntentRestrictedWhileLocked 展開し、アクセスが制限されている意図のクラス名を追加します。例の MonkeyChat アプリでは、チャットメッセージを送信するためにユーザーがログインしている必要があるため、を追加 INSendMessageIntentしました。

Visual Studio for Mac
Visual Studio

使用可能な意図ドメインの完全な一覧については、「Apple のインテントドメインリファレンス」を参照してください。

メインクラスの構成

次に、開発者は、Siri へのインテント拡張機能のメインエントリポイントとして機能するメインクラスを構成する必要があります。デリゲートに準拠IINIntentHandlerするサブクラスINExtensionである必要があります。次に例を示します。

using System;
using System.Collections.Generic;

using Foundation;
using Intents;

namespace MonkeyChatIntents
{
    [Register ("IntentHandler")]
    public class IntentHandler : INExtension, IINSendMessageIntentHandling, IINSearchForMessagesIntentHandling, IINSetMessageAttributeIntentHandling
    {
        #region Constructors
        protected IntentHandler (IntPtr handle) : base (handle)
        {
            // Note: this .ctor should not contain any initialization logic.
        }
        #endregion

        #region Override Methods
        public override NSObject GetHandler (INIntent intent)
        {
            // This is the default implementation.  If you want different objects to handle different intents,
            // you can override this and return the handler you want for that particular intent.

            return this;
        }
        #endregion
        ...
    }
}

アプリが Intent Extension メインクラス ( メソッド) に実装する必要がある単一のメソッドが GetHandler 1 つあります。このメソッドは SiriKit によって Intent に渡され、アプリは、指定された意図の種類に一致する インテントハンドラー を返す必要があります。

例の MonkeyChat アプリは 1 つの意図のみを処理するため、メソッドでそれ自体を GetHandler 返しています。拡張機能が複数の意図を処理した場合、開発者は意図の種類ごとにクラスを追加し、メソッドに渡されたに Intent 基づいてインスタンスをここに返します。

解決ステージの処理

解決ステージは、意図拡張機能が Siri から渡され、ユーザーの会話を介して設定されたパラメーターを明確にして検証する場所です。

Siri から送信されるパラメーターごとに、メソッドがあります Resolve 。アプリは、ユーザーから正しい答えを得るために Siri のヘルプを必要とする可能性があるすべてのパラメーターに対して、このメソッドを実装する必要があります。

例の MonkeyChat アプリの場合、意図拡張機能では、メッセージの送信先として 1 人以上の受信者が必要になります。リスト内の受信者ごとに、拡張機能は次の結果を得ることができる連絡先検索を実行する必要があります。

一致する連絡先が 1 つだけ見つかりました。
2 つ以上の一致する連絡先が見つかります。
一致する連絡先が見つかりません。

さらに、MonkeyChat には、メッセージの本文のコンテンツが必要です。ユーザーがこれを指定していない場合、Siri はユーザーにコンテンツの入力を求める必要があります。

意図拡張機能では、これらの各ケースを適切に処理する必要があります。

[Export ("resolveRecipientsForSearchForMessages:withCompletion:")]
public void ResolveRecipients (INSendMessageIntent intent, Action<INPersonResolutionResult []> completion)
{
    var recipients = intent.Recipients;
    // If no recipients were provided we'll need to prompt for a value.
    if (recipients.Length == 0) {
        completion (new INPersonResolutionResult [] { (INPersonResolutionResult)INPersonResolutionResult.NeedsValue });
        return;
    }

    var resolutionResults = new List<INPersonResolutionResult> ();

    foreach (var recipient in recipients) {
        var matchingContacts = new INPerson [] { recipient }; // Implement your contact matching logic here to create an array of matching contacts
        if (matchingContacts.Length > 1) {
            // We need Siri's help to ask user to pick one from the matches.
            resolutionResults.Add (INPersonResolutionResult.GetDisambiguation (matchingContacts));
        } else if (matchingContacts.Length == 1) {
            // We have exactly one matching contact
            resolutionResults.Add (INPersonResolutionResult.GetSuccess (recipient));
        } else {
            // We have no contacts matching the description provided
            resolutionResults.Add ((INPersonResolutionResult)INPersonResolutionResult.Unsupported);
        }
    }

    completion (resolutionResults.ToArray ());
}

[Export ("resolveContentForSendMessage:withCompletion:")]
public void ResolveContent (INSendMessageIntent intent, Action<INStringResolutionResult> completion)
{
    var text = intent.Content;
    if (!string.IsNullOrEmpty (text))
        completion (INStringResolutionResult.GetSuccess (text));
    else
        completion ((INStringResolutionResult)INStringResolutionResult.NeedsValue);
}

詳細については、 Resolve Stage Reference と Apple の意図の解決と処理に関するリファレンスを参照してください。

確認ステージの処理

確認ステージは、意図拡張機能がユーザーの要求を満たすためにすべての情報を持っていることを確認する場所です。アプリは、Siri に何が起こるかをサポートするすべての詳細を確認して、これが意図したアクションであることをユーザーに確認できるように、確認を送信したいと考えています。

[Export ("confirmSendMessage:completion:")]
public void ConfirmSendMessage (INSendMessageIntent intent, Action<INSendMessageIntentResponse> completion)
{
    // Verify user is authenticated and the app is ready to send a message.
    ...

    var userActivity = new NSUserActivity (nameof (INSendMessageIntent));
    var response = new INSendMessageIntentResponse (INSendMessageIntentResponseCode.Ready, userActivity);
    completion (response);
}

詳細については、ステージの確認に関するリファレンスを参照してください。

意図の処理

これは、ユーザーの要求を満たし、結果を Siri に渡してユーザーに通知できるようにするために、意図拡張機能が実際にタスクを実行するポイントです。

public void HandleSendMessage (INSendMessageIntent intent, Action<INSendMessageIntentResponse> completion)
{
    // Implement the application logic to send a message here.
    ...

    var userActivity = new NSUserActivity (nameof (INSendMessageIntent));
    var response = new INSendMessageIntentResponse (INSendMessageIntentResponseCode.Success, userActivity);
    completion (response);
}

public void HandleSearchForMessages (INSearchForMessagesIntent intent, Action<INSearchForMessagesIntentResponse> completion)
{
    // Implement the application logic to find a message that matches the information in the intent.
    ...

    var userActivity = new NSUserActivity (nameof (INSearchForMessagesIntent));
    var response = new INSearchForMessagesIntentResponse (INSearchForMessagesIntentResponseCode.Success, userActivity);

    // Initialize with found message's attributes
    var sender = new INPerson (new INPersonHandle ("sarah@example.com", INPersonHandleType.EmailAddress), null, "Sarah", null, null, null);
    var recipient = new INPerson (new INPersonHandle ("+1-415-555-5555", INPersonHandleType.PhoneNumber), null, "John", null, null, null);
    var message = new INMessage ("identifier", "I am so excited about SiriKit!", NSDate.Now, sender, new INPerson [] { recipient });
    response.Messages = new INMessage [] { message };
    completion (response);
}

public void HandleSetMessageAttribute (INSetMessageAttributeIntent intent, Action<INSetMessageAttributeIntentResponse> completion)
{
    // Implement the application logic to set the message attribute here.
    ...

    var userActivity = new NSUserActivity (nameof (INSetMessageAttributeIntent));
    var response = new INSetMessageAttributeIntentResponse (INSetMessageAttributeIntentResponseCode.Success, userActivity);
    completion (response);
}

詳細については、ハンドルステージリファレンスに関するページを参照してください。

意図 UI 拡張機能の追加

オプションの Intents UI 拡張機能は、アプリの UI とブランドを Siri エクスペリエンスに取り込み、ユーザーにアプリへの接続を感じさせる機会を提供します。この拡張機能を使用すると、アプリはブランドだけでなく、ビジュアルやその他の情報をトランスクリプトに取り込むことができます。

意図拡張機能と同様に、開発者は Intents UI 拡張機能に対して次の手順を実行します。

意図 UI 拡張機能プロジェクトを Xamarin.iOS アプリソリューションに追加します。
Intents UI Extension Info.plist ファイルを構成します。
Intents UI Extension メインクラスを変更します。

詳細については、意図 UI 拡張機能リファレンスと Apple のカスタムインターフェイスリファレンスの提供に関するページを参照してください。

拡張機能の作成

ソリューションに Intents UI 拡張機能を追加するには、次の操作を行います。

Visual Studio for Mac
Visual Studio

Solution Pad の [ソリューション名] を右クリックし、[新しいプロジェクトの追加]> を選択します。
ダイアログボックスで [ iOS>拡張機能>インテント UI 拡張機能 ] を選択し、[ 次へ ] ボタンをクリックします。
次に、インテント拡張機能の名前を入力し、[ 次へ ] ボタンをクリックします。
最後に、[ 作成 ] ボタンをクリックして、意図拡張機能をアプリソリューションに追加します。
ソリューションエクスプローラーで、新しく作成された意図拡張機能の References フォルダーを右クリックします。共通の共有コードライブラリプロジェクト (上記で作成したアプリ) の名前を確認し、[OK] ボタンをクリック します 。

Info.plist の構成

意図 UI 拡張機能の Info.plist ファイルを構成して、アプリを操作します。

一般的なアプリ拡張機能と同様に、アプリにはと NSExtensionAttributesの既存のNSExtensionキーが含まれます。意図拡張機能の場合、構成する必要がある新しい属性が 1 つあります。

IntentsSupported は必須であり、アプリがインテント拡張機能からサポートする意図クラス名の配列で構成されます。

Visual Studio for Mac
Visual Studio

インテント UI 拡張機能のInfo.plistファイルを構成するには、ソリューションエクスプローラーでダブルクリックして編集用に開きます。次に、ソース ビューに切り替え、エディターでキーと NSExtensionAttributes キーを展開NSExtensionします。

Visual Studio for Mac
Visual Studio

使用可能な意図ドメインの完全な一覧については、「Apple の意図ドメインリファレンス」を参照してください。

メインクラスの構成

インテント UI 拡張機能のメインエントリポイントとして機能するメインクラスを Siri に構成します。インターフェイスに準拠IINUIHostedViewControllerするのUIViewControllerサブクラスである必要があります。次に例を示します。

using System;
using Foundation;
using CoreGraphics;
using Intents;
using IntentsUI;
using UIKit;

namespace MonkeyChatIntentsUI
{
    public partial class IntentViewController : UIViewController, IINUIHostedViewControlling
    {
        #region Constructors
        protected IntentViewController (IntPtr handle) : base (handle)
        {
            // Note: this .ctor should not contain any initialization logic.
        }
        #endregion

        #region Override Methods
        public override void ViewDidLoad ()
        {
            base.ViewDidLoad ();

            // Do any required interface initialization here.
        }

        public override void DidReceiveMemoryWarning ()
        {
            // Releases the view if it doesn't have a superview.
            base.DidReceiveMemoryWarning ();

            // Release any cached data, images, etc that aren't in use.
        }
        #endregion

        #region Public Methods
        [Export ("configureWithInteraction:context:completion:")]
        public void Configure (INInteraction interaction, INUIHostedViewContext context, Action<CGSize> completion)
        {
            // Do configuration here, including preparing views and calculating a desired size for presentation.

            if (completion != null)
                completion (DesiredSize ());
        }

        [Export ("desiredSize:")]
        public CGSize DesiredSize ()
        {
            return ExtensionContext.GetHostedViewMaximumAllowedSize ();
        }
        #endregion
    }
}

Siri は、インテント UI 拡張機能内の Configure インスタンスのメソッドにUIViewControllerクラスインスタンスを渡INInteractionします。

オブジェクトは INInteraction 、次の 3 つの重要な情報を拡張機能に提供します。

処理中の Intent オブジェクト。
意図拡張の Confirm メソッドと Handle メソッドからの Intent Response オブジェクト。
アプリと Siri の間の相互作用の状態を定義する相互作用状態。

インスタンスは UIViewController Siri との対話の原則クラスであり、から UIViewController継承されるため、UIKit のすべての機能にアクセスできます。

Siri がのメソッドをConfigureUIViewController呼び出すと、ビューコントローラーが Siri Snippit または Maps カードでホストされることを示すビューコンテキストで渡されます。

Siri は、アプリの構成が完了したら、アプリがビューの目的のサイズを返す必要がある完了ハンドラーも渡します。

iOS Designerで UI を設計する

iOS Designerで意図 UI 拡張機能のユーザーインターフェイスをレイアウトします。 ソリューションエクスプローラー内の拡張機能のMainInterface.storyboardファイルをダブルクリックして、編集用に開きます。必要なすべての UI 要素をドラッグしてユーザーインターフェイスを構築し、変更を保存します。

重要

やなどのUIButtonsUITextFields対話型要素をインテント UI 拡張機能UIViewControllerに追加することはできますが、これらは非対話型の意図 UI として厳密に禁止されており、ユーザーはそれらを操作できません。

ユーザーインターフェイスをWire-Upする

iOS Designerで作成された Intents UI 拡張機能のユーザーインターフェイスを使用して、サブクラスをUIViewController編集し、メソッドをConfigure次のようにオーバーライドします。

[Export ("configureWithInteraction:context:completion:")]
public void Configure (INInteraction interaction, INUIHostedViewContext context, Action<CGSize> completion)
{
    // Do configuration here, including preparing views and calculating a desired size for presentation.
    ...

    // Return desired size
    if (completion != null)
        completion (DesiredSize ());
}

[Export ("desiredSize:")]
public CGSize DesiredSize ()
{
    return ExtensionContext.GetHostedViewMaximumAllowedSize ();
}

既定の Siri UI のオーバーライド

意図 UI 拡張機能は、アプリアイコンや UI の上部にある名前などの他の Siri コンテンツと共に常に表示されます。また、意図に基づいて、ボタン ([送信] や [キャンセル] など) が下部に表示される場合があります。

アプリが既定でユーザーに表示している情報 (メッセージングやマップなど) をアプリが置き換えることができるインスタンスがいくつかあります。この場合、アプリは既定のエクスペリエンスをアプリに合わせたエクスペリエンスに置き換えることができます。

意図 UI 拡張機能で既定の Siri UI の要素をオーバーライドする必要がある場合、サブクラスはインターフェイスをIINUIHostedViewSiriProviding実装し、UIViewController特定のインターフェイス要素を表示することをオプトインする必要があります。

次のコードをサブクラスに追加して UIViewController 、意図 UI 拡張機能にメッセージの内容が既に表示されていることを Siri に伝えます。

public bool DisplaysMessage {
    get {return true;}
}

考慮事項

Apple は、意図 UI 拡張機能を設計および実装する際に、開発者が次の考慮事項を考慮に入れると提案しています。

メモリ使用量を意識 する - インテント UI 拡張機能は一時的なもので、短時間だけ表示されるため、システムでは、完全なアプリで使用されるよりも厳しいメモリ制約が課されます。
最小表示サイズと最大表示サイズを考慮 する - すべての iOS デバイスの種類、サイズ、向きで意図 UI 拡張機能が適切に表示されていることを確認します。さらに、アプリが Siri に送り返す目的のサイズを許可できない場合があります。
フレキシブルおよびアダプティブレイアウトパターンを使用する - ここでも、すべてのデバイスで UI が適切に表示されるようにします。

まとめ

この記事では、SiriKit について説明し、Xamarin.iOS アプリに追加して、Siri と iOS デバイス上の Maps アプリを使用してユーザーがアクセスできるサービスを提供する方法について説明しました。

Xamarin.iOS での SiriKit の実装

SiriKit を使用したアプリの拡張

アプリの準備

共通共有コードの移動

拡張機能用アプリの設計

必須エンタイトルメントの設定

アプリの正しいプロビジョニング

Siri 承認の要求

ローカリゼーションと Siri

ユーザー固有のボキャブラリの追加

アプリ固有のボキャブラリの追加

意図拡張機能の追加

拡張機能の作成

Info.plist の構成

メイン クラスの構成

解決ステージの処理

確認ステージの処理

意図の処理

意図 UI 拡張機能の追加

拡張機能の作成

Info.plist の構成

メイン クラスの構成

iOS Designerで UI を設計する

ユーザー インターフェイスをWire-Upする

既定の Siri UI のオーバーライド

考慮事項

まとめ

関連リンク

その他のリソース

メインクラスの構成

メインクラスの構成

ユーザーインターフェイスをWire-Upする