macOSのショートカットについて

macOSのショートカットについて

ショートカットがmacOSでも使えるようになるにあたり、Appがそのプロセスにおける重要パートを担います。Appの機能をショートカットアクションとして公開することで、Appの機能を向上させる方法を確認しましょう。Catalyst や AppKit で作成された macOS Appにおいてアクションを構築する方法、プラットフォーム間でアクションを展開する方法、ショートカットを公開して共有する方法、他のAppからのショートカットをAppで実行する方法について解説します。また、ショートカットがAutomatorやAppleScriptなどの既存のMacオートメーション技術とどのように連携するかについても説明します。

リソース
関連ビデオ

Tech Talks
- macOS Montereyに向けた組織での準備
WWDC21
ダウンロード

はじめまして！アヤカです今日はMacのショートカットを紹介します
まずは簡単にMacのショートカットの概要からそして今年更新される内容についてお話しますショートカットを使えば繰り返し作業を自動化したり異なる Appの機能をつなげて問題に取り組むことができますクリエイティブにテクノロジーを使えます Macのショートカットは自動化をこれまで以上に楽しく身近なものにします
最初にAppを開いた時点ですでにショートカットは iPhoneと同期されています Appにはショートカットギャラリーも含まれており Mac独自のものなど新しいショートカットがすでに使用可能ですご自分のショートカットを作りたい場合はエディタで編集することもでき Macでの使用を前提にデザインを一新しましたちなみにMac Appはほぼすべて SwiftUIで記述されていますこれにより iOSとMacのApp間でコードベースを統一しつつプラットフォームに合わせた細部調整が可能です
iOS同様 MacのどのAppでもショートカットを提供することが可能ですこのセッションでは iOSのApp MacのApp Mac Catalystで構築された Appのどの開発でも Appでショートカットをサポートすることで macOS上でのパワフルなワークフローの実現について確認します
またAppleScriptやAutomator など既存ツールを含め Mac自動化におけるショートカットの位置づけについても説明します
さらに今年は集中モードとサウンド認識の２つのオートメーションタイプが追加されたほかウィンドウやファイルを管理するための新しいアクションなどさまざまな機能が追加されました
皆さんのAppでもカスタムアクションを提供し強力なショートカットを作る方法を紹介します
ファイルプロバイダーと統合しているAppの場合これらの新しいファイルアクションはそのAppが提供するファイルに自動で対応しますまた既存のSiriKitのメッセージIntentを採用している Appであればカスタムのメッセージ送信アクションを介しこの機能を自動的に使えるようにします
また共有においても開発の方に喜んでいただける面白い機能がいくつか追加されました今年はショートカットの配布をより簡単にしましたまたショートカットをファイルとして配布できる新ファイル形式もありますまた仲間とショートカットを共有するのに便利なプライベート共有も可能になりました見てみましょう
特別な設定を行わなくてもショートカットをダウンロードできますつまり自分の WebサイトやAppで独自のショートカットを配布できるのです
例えばAppのアクションを利用した素晴らしいショートカットを提供したいとしましょうそのショートカットを作成してiCloudに共有すると Appleがそのショートカットを公証してリンクに変えるので AppやWebサイトで紹介し簡単にダウンロードしてもらうことができます
ライブラリの写真のように Appにデータを渡すショートカットをダウンロードする際にはより具体的な許可を求めるメッセージを表示することでユーザーが自分のデータを管理できます他にもありますショートカットはファイルとして共有することができ iCloud外で配布するのに便利です iCloudのリンク同様ショートカットファイルは Appleが安全性を公証します
最後に iCloudにアップロードせずに個人的にショートカットを共有する新しいモードがあり連絡先での共有や個人的なバックアップに利用できます
ショートカットファイルは送信した人のIDで署名されます署名し直したい場合は新しいコマンドラインツールを使いますこれが今年のショートカットにおいて更新された内容ですではショートカットがどのようにMacの既存のオートメーション技術に適用されるのか見てみましょう AppleScript Automator シェルスクリプトなど Macはオートメーションを昔からサポートしています今回ショートカットが AppleScriptとシェルスクリプトをサポートするようになりましたショートカットに内蔵された新しいアクションにおいてショートカットエディタ内で直接スクリプトを書いて実行できます
次にAutomatorを見てみましょう Automatorは反復的な作業を自動化するためのワークフローを作成できる Mac既存の自動化ツールですショートカットは Macの自動化の未来ですですがAutomatorはまだまだ大切で頼るところも大きいでしょう Automatorからショートカットへの移行は簡単です Automatorのワークフローをショートカットに変換できる移行ツールを作りました例えば Finderで選択した PDFドキュメントから画像作成するワークフローがあればショートカットはそれをインポートして Automatorの各アクションをショートカットアクションに変えることができます
ワークフローファイルをショートカットAppでドラッグして開くか右クリックメニューで開くだけですあなたのワークフローがショートカットになります migratorを有効にするためシェルスクリプトや AppleScriptを実行したりファイル管理など人気のAutomatorのアクションをショートカットに加えましたもちろんこれらのアクションは migratorでサポートしていますショートカットをどのように Appに適用できるのかユーザーにとっての価値についてもお話します Appをショートカットと統合する主な方法はアクションを介し機能を公開することですショートカットにアクションを公開することでユーザーはAppの機能を素早く使うことができ Appを活かしたワークフローが実現しますそして他のAppと組み合わせて使うこともできます詳しく見てみましょう macOSにはショートカットを使える場所がたくさんあります皆さんのAppのアクションを公開するとショートカットAppやショートカットメニューまたはキーボード入力や Spotlight検索でユーザーは突然活用できるようになります
つまりこれまでよりも早くより多くの場所で皆さんのAppの機能を利用できるようになるのですさらにAppのアクションは強力なマルチステップのショートカットの一部として使用できます例えばタスクを管理するための ToDoAppを作ったとします Appの機能をアクションとして公開すると突然そのアクションを使って強力なワークフローを作ることができるようになります例えば明日締め切りの ToDoをすべて検索し優先度を高く設定しリストで表示するショートカットをワンクリックで作成することができますアクションをフックする方法は多岐にわたるためアクションをいくつか公開するだけで Appの機能に何千ものユースケースを実現できますまた Appのアクションを公開することで他のAppと連携して利用することもできます
例えば画像編集Appを作ってカスタム画像フィルターを適用するアクションを公開するとそのアクションを使って写真を選択して画像フィルターを適用しワンクリックで SNSに投稿するというワークフローを作ることができますアクションを公開することで Appでできることを飛躍的に増やすことができる例を紹介しました “優れたアクションのデザイン” のセッションでは Appを使って人々を支えるためにどのようなアクションを提供できるか紹介していますではイアンに引き継ぎます彼がこれらのアクションをビルドする方法を説明しますどうもイアンです MacのAppのショートカットアクションを構築する方法を紹介します後で統合のために留意すべき考慮事項について説明しますではアクションを構築しましょうショートカットのアクションはSiriKitとしても知られる Intentsフレームワークを使って構築されていますこのセッションでは私が共同作業用のタスク管理Appを開発中と仮定しますタスクのリストを期日ごとに記録しそのタスクを他の人と共有することができる AppですこのAppの機能をどのMacからでも使えるようにすることが重要ですショートカットと統合しタスクを含む複数ステップのショートカットを構築できるようになりました
Appを見てみるとユーザーが接するコンテンツの種類は主にタスクですタスクにはいくつか重要な属性がありますまずタイトルですがこれは何をするべきかを説明するテキストですタスクには期日が設定され他の人とタスクを共有するためのリンクもあります Appのタスクに関連して実行できる操作がたくさんありますがこれは動詞と考えていいでしょう新しいタスクを追加したり既存のタスクを編集･削除または特定の条件にマッチしたタスクを取得したり Appが特定のタスクを表示することもできますこれらの動詞に対しアクションを作りますこれらはユーザーが呼び出すことのできる原始的な操作となり人々が一緒に使うことができるよう設計されています
例えばタスクを取得してそれを削除するこれをペアにすることができます
タスクを作成するだけでノートから選択されたテキストを取得し必要に応じてテキストを大文字にしユーザーに期日の入力を求める自動ワークフローを作成することができますショートカットはそのテキストと期日をタスクの作成アクションに渡しタスクを作成する意図を Appに伝えますこのAppでタスクが作成されると Intentは共有URLを含むタスクを返しショートカットはそのリンクをメッセージで誰かに送ることができます
これはほんの一例ですショートカットには多くのアクションがあるためタスク作成アクションの活用方法はほぼ無限大です Appが公開するアクションがわかったので早速実装してみましょう
実装の最初のステップは AppのIntent定義ファイルの作成ですこのファイルをXcode プロジェクトに追加するとソースコードと一緒にコンパイルされます
今回は Mac用のかなりベーシックな SwiftUI Appを用意しましたですが使用している UIフレームワークに関わらず Intentを追加するプロセスは非常に似ていますまずは Intent定義ファイルを作成します
テンプレートの選択画面で Intent定義を検索します
デフォルトの名前で大丈夫です Appのターゲットに追加してコンパイルしてください
これが新しい空の Intent定義ファイルです
このファイル内ではAppが実装するIntentと今回のケースではタスクのように使用される他のタイプを定義する必要がありますこのAppにはいくつかのIntentがありそれぞれがこのタスクタイプを参照するのでまずタスクタイプを定義しますそのためには左下の＋ボタンをクリックし新しいタイプを選択します
各タイプには自動的にidentifierと displayString プロパティが設定されます
タスクのタイトルには displayStringプロパティが使えますが期日や共有リンクにはタイプにさらにプロパティを追加する必要がありますまずタスクがいつまでに完了しなければならないか dueDate（期日）のプロパティを追加します
ここでは日付と時間を表現するため TypeはDate Components を選択します
また他の人と共有できるタスクへのリンクである URLも追加します
最初のタスクが完了したので次はIntentを定義していきますこれはタスクを作成するためのIntentになります
“Create Task”と名前をつけてカテゴリを “Create”に変更します
またこの Intentについて簡単な説明を加えます
ユーザーはAppが実装するアクションのリストを見ているときにこれを見ることになります次に Intentのパラメータを定義します Intentは関数のようなものでパラメータはその関数が仕事をするために渡さなければならない引数と考えてください
新しいタスクを作成するためにはタイトルと期日が必要なのでそれぞれのパラメータを作成します共有リンクはタスク作成時に Appが生成するため前もって収集する必要はありませんまずパラメータにタイトルを追加してみましょう
TypeはStringを選択します
各タイプのパラメータにはいくつかのオプションが設定されていますデフォルト値を指定することができますが今回はstringを空にしておきます次にDueDateパラメータで Date Components タイプに設定します
プロンプトを追加します事前に期日を入力しない場合 Appは実行時に期日の入力を求めることができます
両方のパラメータが定義されたのでほぼ完了です最後にショートカット Appのセクションでいくつか項目を記入しますまずInput Parameterを定義しますユーザーはどこかからテキストを受け取りそれをアクションに渡す場合が多いので Input Parameterで Titleを選択しますこれでショートカットを作成する際の操作性が向上し前のアクションのテキストがショートカットにある場合アクションを追加する際に自動的に入力されます最後にSummaryを定義しますこの文字列はユーザーがショートカットでこのアクションを見たときに表示されます “Create task with due date”とします
どちらのパラメータもタスクの作成に必要でアクションを見ると常に表示されるように両方ともsummaryに入れています他にもパラメータがあってそれをSummaryに入れたくない場合は省略しても構いませんその場合ユーザーがアクションを展開し編集できます
Intentを定義すると Xcodeは実装に使用するためのクラスとプロトコルを生成しますではAppをビルドします続行する前に Intent定義に問題がないことを確認しますビルドログに新しいコードがビルドされていますこれらのソースファイルは Intent定義に書かれた内容に基づき Xcodeによって生成されます Xcodeは Taskタイプと CreateTaskIntentのソースコードを生成しました
これらはコードベースで使用できるようになりましたさらにIntentが定義されたので Appを起動して新しいショートカットを作成し新しいCreate task アクションを検索しますコードを書いてないのでこのままでは動作しません次に Appは受信した Intentをディスパッチして処理する必要がありますこのコードは誰かがショートカットやSiriでアクションを実行すると実行されます
Appはどのプロセスで Intentを処理するか決める必要がありますが選択肢は２つあります１つ目はIn-appで処理すること２つ目は別の Intents Extensionを構築することです
In-appの Intentハンドリングでは Appデリゲートに配信されるIntentに応じ Appの状態を操作することができますほとんどのAppはこれでスタートし必要に応じてIntents Extensionに移行します
Intents Extensionは Appに代わって Intentを処理できる軽量のスタンドアロンプロセスです Intentを実行するたびにプロセスを起動する必要があるため Intents Extensionを構築することで Appを起動する必要がなくなり効率的になります
AppとIntents Extension は受信したIntentに対し Intentハンドラのインスタンスを求められますこれを実現するために実装すべきAPIを見てみましょう
In-appの Intentハンドリングのために Appデリゲートメソッドがありハンドラを返します
macOS Montereyでは NSApplicationの DelegateでもこのAPIが利用できるようになりました Intents Extensionsの場合 INExtensionのサブクラスで handlerForIntentメソッドをオーバーライドできます
In-app Intentハンドリングと Intents Extensionsの違いについては WWDC 2020の “インテントの強化” セッションをご覧ください
今度はAppの中に入って In-appのIntentハンドリングを実装してみますまず CreateTaskIntentを Appのサポートされた Intentとして追加することですこれによりシステムはこのIntentがAppのデリゲートに配信されるべきだと知ることができます
次にメインAppのソースコードにアクセスします
まず Appのデリゲートを作成します SwiftUIAppのライフサイクルを使用しているのでオブジェクトをSwiftUIにフックするためのデリゲートアダプターも作成する必要があります
Intentを受け取るには intentsフレームワークをインポートし handlerFor Intentメソッドを実装します
ディスパッチメソッドができたので次はIntentのハンドラを実装します
この例ではインテントを処理するために新しいクラスを作成しますがこれはApp内の任意のオブジェクトで構いません Intentハンドラは “Handling”で終わるこのIntentのために生成されたプロトコルに従わなければなりません Create Taskインテントについては CreateTaskIntentHandling という名前になっています
そしてIntentが CreateTaskIntentの場合新しいIntentHandler オブジェクトを返すように handlerForIntent メソッドを更新します
Xcodeがどのメソッドの実装が必要か教えてくれます
Intentハンドリングのプロトコルには resolve provide options confirm そしてhandleの４種類のメソッドがあります resolveメソッドは各パラメータに応じたものが生成されますこれはパラメータが有効かチェックし無効の場合どうすべきかシステムに伝えることができます
このIntentには２つの resolveメソッドがありますタイトルと期日です
titleパラメータでは値がnilではなく空でもないことをAppが確認する必要があります
titleが空だと needsValueを返し値を入力するようユーザーに促します
due dateパラメータでは同様のものが実装されていて期日がnilではないことを確認するため検証します Appの期日に関する要件を見ると resolveメソッドは期日が未来か確認し期日が過去の場合エラーを表示する必要があります
Intent定義ファイルに戻りカスタムの検証エラーを追加します
invalidDate というコードと “未来の期日を入力してください”とエラーメッセージを入力します
これでAppは先ほど追加したカスタム検証エラーでサポートされていない結果を返すことができ日付が無効であることを示すエラーメッセージが表示されるようになりましたもう１つは provide optionsです Dynamic Optionsの設定が有効になっているパラメータではこちらが表示されます任意の値を入力できないようにし有限のセットのパラメータがある場合はそのパラメータに対しダイナミックオプションを有効にすることができます
そしてIntent実行時に可能な値を指定できる provide optionsというメソッドが作成されショートカットはその値の中から選択を求めますパラメータが個別に resolveされた後 confirmメソッドも実装することができますここではすべてが問題なく見えることを確認し Intentを処理できるようにし問題があればエラーを投げるようにする必要があります例えばネットワーク接続が必要な場合はここで実際にネットワークに到達できるか確認します
最後にハンドルメソッドでは Intentが指示したことを実際に実行します
ハンドルメソッドは App内にタスクを作成し成功を返しますアクションがタスクを作成した後タスクを出力として提供し後のアクションが共有URLなどの属性を使用できるようにする必要があります Intentエディタに戻り Intentのレスポンスセクションに移動しますここに作成したタスクのプロパティを追加します
先に作ったタスクタイプを選択しますそのプロパティをIntentの出力として選択してショートカットで利用できるようにしますコードに戻るとレスポンスにタスクのプロパティがありタスクオブジェクトを割り当てることができます
これが完了すると Intentがアクションとして表示されます必ず時間をかけてテストを行いユーザーがどのように使うかを試してくださいまずショートカット Appを開きタスクの作成アクションを見てみましょう
タスクの名前と日付 “Tomorrow at 3pm”を記入します
実行ボタンを押すとタスクが正常に作成されますですが “Yesterday at 3pm”に変更すると
エラーメッセージが表示されますショートカットでアクションを構築する方法でした最後に Macでショートカットを開発する際に注意すべき点をご紹介します
Mac Catalystで作られたApp ファイルを扱うApp iOSとMacの両方にデプロイするApp ショートカットが必要な Appやツールなど４種類のAppを紹介します
まずMac Catalystを使ってiOS Appを Macに導入する場合知っておくべきことがあります macOS Montereyでは Mac Catalystで構築された Appであれば同じ Intents APIを使用できます新しいAppを作る場合はすべてがiOSと同じように動作する必要があります
しかしあなたのAppがすでにMacで提供されていて iOSでIntentsフレームワークを実装している場合 Macに来る過程で Intentのインテグレーションをコンパイルから外してしまった可能性があります macOS Monterey上で動作させる場合はコードを監査してこの機能を再度有効にしてください
もう一つのタイプのApp として注目したいのがドキュメントベースの Appです先ほどのデモではタスク管理Appが App内に完全に存在するタスクを操作していますが Appの多くはディスク上のファイルとして存在するドキュメントを操作します iOS 15と macOS Montereyでは Intentのファイルパラメータによって特定のファイルを選択し Appのアクションに渡すことができますデータベースではなく主にファイルベースのドキュメントを扱う Appの場合はファイルを操作するアクション群の構築を検討してください例えば表計算Appではドキュメントを開くアクションや特定のファイルの行にデータを追加するアクションを作成できます
サードパーティのショートカットをファイルに適用した例としては Sound Analysisのセッションがあります
iOSとMacの両方に対応する Appを開発する場合アクションを両方で動作させるには Appの両方のコピーに同じIntentを配置する必要がありますこれにより一方でショートカットを構築しもう一方でも同じように動作させることができますそのためには両方のAppに同じIntent定義をコンパイルして Intentの名前とパラメータが同じになるようにします
プラットフォームによっては Appのバンドル識別子が異なる場合がありますが問題ありませんただし同じ名前のIntentは同じApple Developer Team経由でデプロイされた App間でのみ共有されることに留意してください
また iOS 15ではあるバージョンのAppから別のバージョンのAppにアップグレードする場合２つのAppが同じ開発者によるもので同じIntent名を使用していれば Appのショートカットは自動的に一方から他方に引き継がれます最後に Appやコマンドラインツールからショートカットを実行する場合２つの方法がありますまずショートカットは Mac AppやAppleScriptsがショートカットをリストアップして実行するためのスクリプトインターフェイスを公開しますさらにシェルスクリプトやコマンドラインツールでショートカットをリストアップして実行できるショートカットコマンドラインツールもあります
ショートカットを実行する機能が必要なAppやスクリプトを開発する場合はスクリプティングインターフェースを使用してくださいショートカットイベントのプロセスと通信することで Appはユーザーが設定したショートカットのリストを取得したりショートカットの実行を開始できます
AppleScriptではショートカットイベントのプロセスに名前でショートカットを実行させ実現できます
Scripting Bridge フレームワークを使えば SwiftやObjective-CのApp から直接ショートカットを実行するようプロセスに依頼できますサンドボックスAppにおいては “com.apple.security.scripting-targets” というEntitlementを追加します
ショートカットのリストにアクセスして実行するために “com.apple.shortcuts.run”をターゲットに追加する必要があります最後に macOS Montereyにはショートカット一覧表示し名前で実行できるコマンドラインツールもありますコマンドラインツールやスクリプトをお持ちの方はこれを介しショートカットと統合できますまとめます Macでショートカットが利用できるようになりどんなAppでもショートカットのエコシステムに参加すべきです Appにアクションを追加することで人々ができることを増やすことができますショートカットでAppをクリエイティブに使えますユーザーがどんなショートカットを構築するのかを知ることはとても楽しいことでしょう [音楽]

17:10 - Adding Intent dispatch method in SwiftUI

import SwiftUI
import Intents

@main
struct SouperTaskApp: App {
    @NSApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
    
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

class AppDelegate: NSObject, NSApplicationDelegate {
    func application(_ application: NSApplication, handlerFor intent: INIntent) -> Any? {

    }
}

18:32 - Resolve intent

class IntentHandler: NSObject, CreateTaskIntentHandling {
    func resolveTitle(for intent: CreateTaskIntent, with completion: @escaping (INStringResolutionResult) -> Void) {
        guard let title = intent.title, !title.isEmpty else {
            return completion(.needsValue())
        }
        return completion(.success(with: title))
    }
    
    func resolveDueDate(for intent: CreateTaskIntent, with completion: @escaping (CreateTaskDueDateResolutionResult) -> Void) {
        guard let dateComponents = intent.dueDate else {
            return completion(.needsValue())
        }
        return completion(.success(with: dateComponents))
    }

    ...
}

19:37 - Date range validation in dueDate resolve method

func resolveDueDate(for intent: CreateTaskIntent, with completion: @escaping (CreateTaskDueDateResolutionResult) -> Void) {
        guard
            let dateComponents = intent.dueDate,
            let dueDate = Calendar.current.date(from: dateComponents)
        else {
            return completion(.needsValue())
        }
        if dueDate < Date() {
            return completion(.unsupported(forReason: .invalidDate))
        }
        return completion(.success(with: dateComponents))
    }

20:40 - Handle intent

class IntentHandler: NSObject, CreateTaskIntentHandling {
    func handle(intent: CreateTaskIntent, completion: @escaping (CreateTaskIntentResponse) -> Void) {
        let title = intent.title!
        let dueDate = intent.dueDate!
        
        let task = createTask(name: title, due: dueDate)
        
        let response = CreateTaskIntentResponse(code: .success, userActivity: nil)
        response.task = task
        completion(response)
    }
}

25:39 - Running Shortcut from AppleScript

tell application "Shortcuts Events"
	run the shortcut whose name is "Make GIF"
end tell

25:49 - Using scripting bridge

import ScriptingBridge

@objc protocol ShortcutsEvents {
    @objc optional var shortcuts: SBElementArray { get }
}
@objc protocol Shortcut {
    @objc optional var name: String { get }
    @objc optional func run(withInput: Any?) -> Any?
}

extension SBApplication: ShortcutsEvents {}
extension SBObject: Shortcut {}

guard 
    let app: ShortcutsEvents = SBApplication(bundleIdentifier: "com.apple.shortcuts.events"),
    let shortcuts = app.shortcuts else {
    print("Couldn't access shortcuts")
    return
}

guard let shortcut = shortcuts.object(withName: "Make GIF") as? Shortcut else {
    print("Shortcut doesn't exist")
    return
}

_ = shortcut.run?(withInput: nil)

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

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

リソース

関連ビデオ

Tech Talks

WWDC21