先日のWWDC18で発表された、iOS 12の新機能 "Siri Shortcuts"。「よくやる手順を声で呼び出せる」というのはもちろん嬉しいことですが、それよりも、
「ロックスクリーンから呼び出せる」
というところに、プラットフォームの制約の中で取捨選択するしかないいちアプリ開発者としては圧倒的魅力を感じざるを得ません。
「何がどこまでできるのか、どう実装するのか」を掴むべく、まずはその最小実装を確認してみました。
ちなみに参考資料はWWDC 2018のセッション番号211「Introduction to Siri Shortcuts」とサンプルコード「SoupChef」です。1
実装方法は2通り
Siri Shortcutsの実装方法としては、以下の2種類があります。
- NSUserActivityを利用する方法
- Intentsを利用する方法
本記事では、タイトル通り、NSUserActivityを用いたSiri Shortcutsの最小実装だけを紹介します。
Appleのサンプル「SoupChef」は両方の実装が入っており、それはそれでありがたいのですが、初めて挑む人にはどのコードがどっち用なのか、たとえばIntentsを使わない場合はどれを省けるのかといったことがわかりづらいと思うので、そのあたりを本記事で紐解ければと。
3ステップ
NSUserActivityを用いたSiri Shortcutsの実装は、次の3つの手順で行います。
- ショートカットを定義する
- ショートカットを提供する（donate） 2
- ショートカットをハンドルする
「アプリの画面Bを開く」というショートカットをSiri Shortcutsを実現してみます。
1. ショートカットを定義する
Info.plistに次のようにNSUserActivityTypesを定義します。
<key>NSUserActivityTypes</key><array><string>com.myapp.name.my-activity-type</string></array>
2. ショートカットを提供する
Intentsをインポートして、
import Intents
次のようにNSUserActivityを用意します。
extensionNSUserActivity { publicstaticletmyActivityType="com.myapp.name.my-activity-type"publicstaticvarmyActivity:NSUserActivity { letuserActivity= NSUserActivity(activityType:myActivityType) userActivity.isEligibleForSearch =true userActivity.isEligibleForPrediction =true userActivity.title ="My First Activity" userActivity.suggestedInvocationPhrase ="Let's do it"return userActivity } }
一見複雑に見えますが、Siri Shortcutsに関係するポイントとしては、
isEligibleForPredictionプロパティにtrueをセットするsuggestedInvocationPhraseプロパティをセットする- ここにセットしたフレーズがショートカットの音声コマンドをユーザーに録音してもらう画面でサジェストされる
これぐらいです。
Appleのサンプルには、次のようにCSSearchableItemAttributeSetを作成してcontentAttributeSetにセットする実装も入っていますが、
// 省略可letattributes= CSSearchableItemAttributeSet(itemContentType:"hoge") attributes.thumbnailData = UIImage(named:"filename")!.pngData() attributes.keywords = ["foo", "bar"] attributes.displayName ="My First Activity" attributes.contentDescription ="Subtitle" userActivity.contentAttributeSet = attributes
私が試したところではSiri Shortcutsを行うだけであれば省略可能でした3。検索窓（Spotlight）からのテキストによる検索にも対応させたい場合に必要なのではないでしょうか。
作成したNSUserActivityオブジェクトを、ショートカットを提供するUIViewControlllerのuserActivityプロパティ（正確にはUIResponderのプロパティ）にセットします。
userActivity = NSUserActivity.myActivity
ここでもAppleのサンプルでは次のようにupdateUserActivityState(_)をオーバーライドしてNSUserActivityのaddUserInfoEntries(from:)メソッドでuserInfoのデータを供給する実装が入っていましたが、これもなくても動作しました。
// 省略可overridefuncupdateUserActivityState(_ activity:NSUserActivity) { letuserInfo:[String: Any]= [NSUserActivity.ActivityKeys.menuItems:menuItems.map { $0.itemNameKey }, NSUserActivity.ActivityKeys.segueId:"Soup Menu"] activity.addUserInfoEntries(from:userInfo) }
ショートカットでアプリが起動する際に、アプリの状態を復元するために必要なデータ（userInfo）がある場合に実装すべきものと思われます。
なお、ここに出てくるNSUserActivityやCSSearchableItemAttributeSetが初見の方は、「iOS 9 の新機能のサンプルコード集」の「Search APIs」サンプルを実行してみつつコードを読んでみると非常にわかりやすいです。NSUserActivity を使うものと、Core Spotlight を使うものの2種類が実装してあり、コードがシンプルなのでどのプロパティが何に対応してるのかがわかりやすいです。
3. ショートカットをハンドルする
ショートカットが呼び出されてアプリが起動する際、UIApplicationDelegateのapplication(_:continue:restorationHandler:)が呼び出されるので、そこで渡されてくるアクティビティ（NSUserActivity）をハンドルします。
funcapplication(_ application:UIApplication, continue userActivity:NSUserActivity, restorationHandler:@escaping ([UIUserActivityRestoring]?) ->Void) ->Bool { if userActivity.activityType == NSUserActivity.myActivityType { // Restore state for userActivity and userInfoguardletwindow= window, letrootViewController= window.rootViewController as? UINavigationController, letvc= rootViewController.viewControllers.first as? ViewController else { os_log("Failed to access ViewController.") returnfalse } vc.performSegue(withIdentifier:"B", sender:nil) returntrue } returnfalse }
ここではactivityTypeでどのアクティビティかを判定し、あとは愚直にperformSegueで画面Bに遷移させているだけです。
完成品の挙動
NDA期間中のため完成品の挙動をキャプチャしてアップすることができないのですが、
- 設定から当該Siri Shortcutを登録
- ロックスクリーンから登録したフレーズで呼び出す
これでアプリが起動し、画面Bまで自動的に遷移しました。
アプリはバックグラウンドで生きている必要があるのか？
気になったのが、UIViewControllerのuserActivityプロパティに当該NSUserActivityオブジェクトをセットした点です。これってこのView Controllerがショートカットのdonatorであり、アプリが生きてないと呼び出せないのか？と。
というわけでアプリをkillしてもNSUserActivityベースのSiri Shortcutは動作するか試してみました。
結果 → 動作しました。
良かったです。
次回
- Intentsを用いる場合の最小実装
- 両者をどう使い分けるか
- Siri Shortcutsで呼び出せない機能はたとえばどんなものがある？
といったあたりについて書きます。（書けたらいいなと思っています）