クイックメモの採用

クイックメモの採用

Appをクイックメモにリンクして、コンテンツとノート、そしてノートとコンテンツをすばやく結びつける方法を確認しましょう。NSUserActivityを介してクイックメモがAppのコンテンツを認識しリンクする方法と、AppへのAPIの導入方法を紹介します。また、クイックメモをサポートするための要件、メリット、機能についても紹介します。AppでNSUserActivityのメリットをすべて活かすためのガイダンスやベストプラクティスについてもお伝えします。

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

WWDC18
- Siriショートカットの導入
ダウンロード

ニッキー･ブラウアーですペンシル&ペーパーチームのエンジニアです今日はQuick Noteの導入方法について
Quick Noteは新しくシステム統合したノート単にiOSやmacOSでノートを取るだけでなく複数のAppやウェブのコンテンツを一つに統合
これでNoteをどこへでも持ち運べます優れているのは既存のAPIが利用可能という事 NSUserActivityです Handoffなどで採用聞きなじみがあるでしょう
今日は実際にQuick Noteをデモで紹介しますまず基本動作についてお話しますそしてNSUserActivityの導入方法もその後いくつか事例もぜひ役立てて下さい
Quick Noteの新機能についてこれからお話します例としてー Apple Fitness+について調べます登録はまだですがアクションプラン無しはイヤです Notes Appに切り替える代わりにペンシルで画面右下からスワイプアップすると新しいQuick Noteが出現してメモを取り始めることができますこのAppleのサイトには私が必要な情報が全てあり
Quick Noteの上部にはリンク追加のメニューが出ているのでこのウェブサイトへのリンクを追加しておいて後で簡単にこのコンテンツに戻ってくることができます
Quick Noteは picture-in-pictureの様にデバイスのどの角にも動かせピンチでサイズを変更して大小好きな大きさにできます
書き終わったらー左上のDoneボタンで完了ですでも今はまだ追加するものがあるので UIを右にスワイプしてスクリーンのサイドに隠しますウェブサイトだけでなく当然他のAppとも連携します MapsでHIITワークアウト用のいい場所を見つけましたさっきのノートを出しこのロケーションを追加します書き込むスペースを広げるにはツールバーのNotesボタンをタップして Notes Appでそのページを開きます
ここでは、画像やリンクを描画する機能を利用します
私が先程追加したこのリンクは単なる古いリンクではありませんもちろんタップすれば SafariやMapsへ飛ぶでしょうでもこれらのAppから Quick Noteのサジェスチョンによってノートに戻ることができるのです先程のApple Fitness+のサイトへ戻ると Quick Note Suggestions UI が右下に表示されますこれをタップすれば元の場所に戻ってそして週４日から５日 HIITワークアウトと追加できます
今はiPadで書きましたが Macとも連携しています
先程のApple Fitness+のページを開くと Quick Note Suggestions UI がMacでも現れますここをクリックすれば Notes App の該当ページを直接開きます Quick Noteを紹介しました仕組みを見てみましょう NSUserActivityオブジェクトは Appの状態を保存し後で再利用する方法を提供します UserActivityオブジェクトは現状の動作を把握する為のものでウェブの閲覧やAppの表示内容などそしてそうした履歴をシステムに保存します
システムは受け取った履歴を Handoffなどに送ります
Quick Noteのリンクもこのシステムに依存しています
アクティビティーは Handoff Spotlight Reminders に加えて Quick Noteへも送られますこれが Noteのメニューに追加するリンクが表示されたり Quick Note Suggestionsが起動される仕組みです
NSUserActivityには３つのプロパティがあります AppのコンテンツとQuick Noteをリンクする永続的な識別子ですエコシステムを構成するには１つ以上のプロパティが必要です targetContentIdentifierと persistentIdentifier そしてwebpageURLですどれを選択するかはサポートしたい機能で決まります
targetContentIdentifierもステートのリストアで使われますこのプロパティはiPadでの優れたマルチタスク体験を提供します
persistentIdentifierはシステムのSpotlightインデックスで Appのコンテンツ照会に使われます webpageURLはHandoffの Webフォールバックにも使用されます Quick Noteのリンクを使うにはいくつかのプロパティと識別子が必要ですあらゆるデバイスで利用するためにユニークでグローバルな識別子である必要があります時間が経過してもそのコンテンツが十分安定して機能する必要がありますユニークでグローバル、そして安定したアクティビティの識別子が Quick Note Suggestionsを有効にします Apple Fitness+のサイトを再び開くと Quick Note Suggestions UIが出る理由もリンク内の識別子が１時間前あるいは半年前に作られてもウェブサイト上の識別子に合致するからです
NSUserActivityを導入するステップは３つサポートするアクティビティをあなたのAppのInfo.plistで宣言し折々のタイミングで画面に表示されている内容を表すユーザーアクティビティを作成そして登録しますそして受信した要求を処理してアクティビティの続きを実行可能とします
この要求はQuick Noteのリンクや他のデバイスからかもしれませんあなたのアプリが対応するアクティビティタイプをキー NSUserActivityTypes で Info.plist ファイルに宣言します
システムはそのキーの情報を使用して Appが特定のユーザーアクティビティを処理できるかどうかを判断します NSUserActivity オブジェクトの作成には plistに登録済のactivity type stringsとタイトルを指定しますそして説明した３つの識別子から１つ以上を指定しますこれらの識別子は全て Quick Noteで有効です例えばiPad用のAppでステートのリストアをサポートする場合… targetContentIdentifier を設定し userInfoプロパティにアクティビティ継続の為に必要な Appのステート情報をセットします
そしてこれをresponderにアタッチします
マニュアルでAppのアクティビティを登録する代わりにシステムにやらせる事ができます responderのactivityに設定すればオブジェクトは UIKitかAppKitが管理します
NSUserActivityはクロスプラットフォームなのでこのコードは iOSとmacOSで共に有効です最後のステップは受信したアクティビティからの App内の状態のリストアですリンクがタップされると Quick NoteがAppを起動し UIWindowSceneDelegate の scene の willContinueUserActivityWithType を呼び出しますアプリアクティビティを受信している事のフィードバックをここで出せます
Quick Noteが Appのアクティビティを scene(continue userActivity:) で提供しますここで view controllersやviewの設定を行い userInfo辞書を使ってリストアを行いアクティビティを継続させます Handoffの場合デバイスが接続できない時はシステムが呼び出すのはsceneの (didFailToContinueUserActivityWithType) ここでエラーメッセージを出しますこのメソッドはQuick Noteでは呼ばれませんが NSUserActivityを包括的に採用するために実装することをお勧めします
macOS Appでは同等の application (willContinueUserActivityWithType)と application(continue userActivity) そして application (didFailToContinueUserActivityWithType) これらをAppのdelegateで実装します NSUserActivity対応の詳細は WWDC 2014の "Adopting Handoff on iOS 8 and OS X" を参照してください
NSUserActivityは多くの機能を司るゲートウェイです
Quick Noteに対応するための作業はこれが全てです Handoffはデフォルトで有効その他はopt-inですあなたのAppをさらにパワーアップしましょう Appのドキュメントにリマインダーの機能を付けたり Appから投稿したブログを Spotlightで表示したりマルチウィンドウ処理を改善することができます。
最新資料や WWDCの映像で詳細を確認してくださいそれでは最後に Quick Noteに対応するための NSUserActivityの導入についてベストプラクティスを見てみましょう４つの挙動について話しますそれぞれをAppに統合する理由と方法についてお話します
titleのプロパティは人間が可読なアクティビティの文字列です
リンクを追加するメニューの中に表示されますこのようにタイトルはーコンテンツを簡潔に説明したもので文書やアイテムの名前をそのまま使う事を推奨します
識別子をユニークかつ安定したものにするため
デバイス内にしかないデータは避けましょう例えばこの写真の識別子がローカルのファイルパスである場合このリンクはこれを作成したデバイスのみで使用可能となります session IDのように一時的なものや特定の表示用のプロパティは避けましょう写真のタイトルは一意に思えますがそれが変更できる場合後でこのコンテンツに戻った時まだそのままの保証はありません
長期的に考えれば写真にUUIDを使えば Quick Noteリンクのリストアに役立ちますコンテンツが移動していても大丈夫です URLはAppのコンテンツの一意の識別子にすることができますが一時的な状態情報が含まれていることが多く前述の識別子のガイドラインに違反しています Quick NoteではwebpageURLよりも targetContentIdentifierと persistentIdentifierを優先します webpageURLもガイドラインに沿っていれば使用可能です Appが状態のリストアとSpotlight 両方にNSUserActivityを使う場合 targetContentIdentifierと persistentIdentifierに同じ値を使用しますあなたのAppをサポートするウェブサイトがある場合第二のフォールバック識別子として URLを追加します Appがインストールされていない場合リンク先を代わりに開きます
もう１つ重要な事は NSUserActivityを常に最新に設定する事起こっていることを常に更新します
titleと識別子で常に正確に把握できるように違う写真を選択した時など変更を検知した時に更新します
アクティビティインスタンスの再利用は推奨しません写真の追加ような新コンテンツには新しいアクティビティを作成しましょう
サンプルコードで示した様に viewControllersやviewなどの responderにアクティビティを付けて UIKitとAppKitに現在のAppのアクティブティを処理させましょう responderへの添付が正しく動作しない場合は適切なタイミングでbecomeCurrent()と resignCurrent()を呼び出すことにより現在のAppアクティビティを手動で管理できます例えば写真の表示が終了したら Appは現在のアクティビティで resignCurrent()を呼び出し新しい写真が選択されたら Appは新しいアクティビティで becomeCurrent()を呼び出します
パフォーマンスを向上させるにはアクティビティの”needsSave"を使います Appでアクティビティを適切にリストアするには特定のビュープロパティが必要な場合があります例えばマップを表示するときの位置やズームこれらのプロパティはアクティビティと一緒に渡すことができますがすべてのジェスチャの後に更新するとオーバーヘッドがありますそこでアクティビティを更新する代わりに needsSaveの値をtrueに設定するとシステムがアクティビティをQuick Noteか Handoffに送信する必要がある場合にデリゲートコールバック userActivityWillSaveが呼び出されるので Appは必要な時にだけ全てのプロパティを更新できるようになります
このコールバックでuserInfo辞書を更新してアクティビティのリストアに必要なプロパティを含めることができます
対応すべき互換性の問題がいくつかありますもしAppが更新されたら？このノートには１つのAppから２つのリンクが追加されていますこのリンクはそれぞれデバイス上の新旧のバージョンのAppから取得されましたまったく問題ありませんがリンクは引き続き機能する必要があります互換性を維持する為には旧バージョンで保存したアクティビティのリストアに対応する必要があります新バージョンで作成したアクティビティのリストアは「正しく」失敗しましょうアクティビティのバージョン管理、辞書を使用した場合のキーの欠落や未知のキーのハンドリングなどでうまくサポートできる可能性がありますコンテンツがもう存在しない場合は？
アクティビティのリンク先のコンテンツが削除または移動された可能性があります Appに戻った時に削除された場合はエラーメッセージを表示しコンテンツが移動された場合はリダイレクトします AppにQuick Noteを導入するとノートの取り方が変わりますこのシステムでユーザーとコンテンツそしてAppの繋がりが向上します NSUserActivityを使用している事を確認してください今こそ既存のコードを再検討して磨き上げる絶好の機会です
またユニークでグローバルそして安定した識別子を使います respondersでアクティビティを設定してシステムがAppの現在のNSUserActivityを管理できるようにしますありがとう Quick Note等を活かしたー Appを楽しみにしていますパーカッシブな音楽

16:57 - How to adopt NSUserActivity to support Quick Note

// Create the NSUserActivity and describe the content or user activity
let activity = NSUserActivity(activityType: "com.myapp.MyActivityType")
activity.title = document.title

// Set one or more of:
//   .targetContentIdentifier
//   .persistentIdentifier
//   .webpageURL
activity.targetContentIdentifier = "uniqueGlobalStableIdentifier"

// Set userInfo to save app-specific state information 
activity.userInfo = ["myKey": …]

// Attach it to a view controller, window, or other responder; let the system make it current when needed
viewController.userActivity = activity

17:02 - Handle NSUserActivity continuation in your window scene delegate or app delegate - iOS

class SceneDelegate: UIResponder, UIWindowSceneDelegate {

    func scene(_ scene: UIScene, willContinueUserActivityWithType userActivityType: String) {
        // show user feedback while waiting for the NSUserActivity to arrive
    }
    
    func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
        // set up view controllers and views to continue the activity
    }
    
    func scene(_ scene: UIScene, didFailToContinueUserActivityWithType userActivityType: String, error: Error) {
        // show error about failing to continue an activity
    }

    …
}

17:06 - Handle NSUserActivity continuation in your window scene delegate or app delegate - macOS

class AppDelegate: NSObject, NSApplicationDelegate {

    func application(_ application: NSApplication, willContinueUserActivityWithType userActivityType: String) -> Bool {
        // show user feedback while waiting for the NSUserActivity to arrive
        return true
    }
    
    func application(_ application: NSApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([NSUserActivityRestoring]) -> Void) -> Bool {
        // set up view controllers or documents to continue the activity
        return true
    }
    
    func application(_ application: NSApplication, didFailToContinueUserActivityWithType userActivityType: String, error: Error) {
        // show error about failing to continue an activity, if appropriate
    }
    
    …
}

17:26 - Improve performance with needsSave

activity.needsSave = true

…

func userActivityWillSave(_ userActivity: NSUserActivity) {
    userActivity.userInfo = [
        "center" : visibleFrame.middle
        "zoomScale" : scrollView.zoomScale
    ]
}

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

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

リソース

関連ビデオ

WWDC18