このページについて
今回はショートカットのXコールバックについての解説になります。普段聞き慣れないワードが並ぶため、まずは用語の紹介からしていきます。
2021/10月~2022/1月 iPadOS15にて確認した内容に更新
Xコールバックって何
そもそもコールバックって何なんって話ですよね。そこからある程度解説していきます。
コールバック
コールバックは電話とかの折返しみたいな意味合いです。「処理の途中で別の機能を呼び出して処理をし、再び元の処理に戻る」事を意味します。
そしてコールバックに関連した、コールバック関数というものがあります。コールバック関数を簡単に言うと、「処理の途中で呼び出される側の関数」のことを言います。何かしらの計算処理をさせる際に使う計算式ですが、この計算式は関数と言います。関数Aの途中で関数Bを呼び出し、Bの結果を関数Aに代入するという処理を行うとします。
この一連の処理の中で呼び出される側の関数の事を引数(ヒキスウ)と言います。そしてこの引数によって呼び出される関数Bの事を、コールバック関数と言います。
コールバックURL
コールバックの中身がほんの少しわかった所で､今回のアクションは｢コールバックURL｣ですね。URLがつくと何が変わるのかというと､関数=サイトになる点ぐらいです。
例えばグーグルでアカウントを作成し､ポケモンGOに新規登録したとします。このときグーグルアカウントで登録することができますが､操作としてはポケモンGOで新規登録→グーグルアカウントの認証→ポケモンGOに戻るという処理がなされます。このように｢一旦別のサイトの認証を得るために別のサイトを開くが､処理が正常に終わったら元のサイトに戻る｣っていう一連の処理をするための機能が､コールバックURLです。
特にこのXコールバックはアプリ間連携においてよく使われるそうです。具体的にはショートカットを別アプリから起動させたりとか。そういった特殊な使い方になるため､ショートカット自体を軽く使っている方にはほぼ無縁の機能と言えます。
X-callback-url
そして肝心のXコールバックURLって何って話ですが、これはAppleが策定したURLスキームの統一化みたいなもんだと思ってもらえば良いです。アプリごとに異なる形式のURLスキームが乱立していて困るから書式を統一してみんなが使いやすいようにしようよってことで策定され、いくつかのアプリが実際に採用しています。
今回の例ではBearというメモアプリを利用しますが、Bearの公式サイトには大量のXコールバック用のパラメータなどが公開されています。アプリによっては公開されているケースもあれば、公開されていないケースもあるようです。
アクションの解説
ここまで読んだら大体分かるんでは?って感じですが､実際に追加してみると中々です。以下が実際のアクション画面。
X-Callback URL
X-Callback URLのところにURLスキームなどを入力します。ショートカットから別のショートカットを起動するにはApp→ショートカットを実行のアクションでできますが、ショートカットから別のアプリを起動する・別のショートカットへ入力を渡すにはスキームを利用する必要があります。
ショートカットを実行については以下を参考にしてください。
このURLスキームで別のアプリを起動するにはそれぞれのアプリのURLスキームが必要となります。ツイッターで投稿するスキームを利用して試してみましょう。
- テキスト
- URLエンコード
- X-コールバック
の順番にアクションを配置し、X-Callbackに以下のURLを入力します。
twitter://post?message=
=の後にURLエンコード済みのテキストをマジック変数で配置すれば、テキスト内に入力したものがツイート画面に入力されているはずです。これがURLスキームの基本的な使い方になります。
URLエンコードについては以下を参考にしてみてください。
カスタムコールバック
｢xコールバックURLに準拠せず､成功/エラー/キャンセル以外のキーが使用されるURLを開きたい場合はチェックを入れる｣という説明ではあまり理解できそうもないですが、公式サイトにより詳しく書かれていました。
- サクセスキー→Xコールバックが正常に処理された場合に開くURLですが、正常に処理された場合にはURLにresultという名前が付与されるらしいです。
- キャンセルキー→処理がユーザーによってキャンセルされた場合に開くURL。
- エラーキー→エラーが発生した際に開くURL。
不要であればチェックをオフにしたり、未入力でも問題はありません。
カスタムx-success URL
ONにするとコールバックの値を任意に設定出来ます。OFFの場合､デフォルトの値が使用されます。デフォルトはshortcuts://callbackです。
X-Success URL
何度試しても機能しているようには思えず、詳しく書かれているところも見当たらなかったので内容を消しておきます。
使用例
今回はBearというメモアプリとの連携をやってみたいと思います。Bearをインストールしておいてください。
ショートカットを新規作成し、Xコールバックを配置。URLの部分に以下をペーストします。
bear://x-callback-url/create?title=test&tags=shortcut
カスタムコールバック・X-Success URLについては設定しなくてもOKです。このまま実行すると、Bearでタイトルがtestというメモが作成されており、タグにshortcutが付与されているはずです。
そしてbearでの作成が終わると、元のショートカットへと戻ってくると思います。これがXコールバックの簡単な使い方となります。