Skip to content

「info.json」ファイルの仕様2「ユーザー側の情報を取得する」(リクエスト機能)

KEINOS edited this page Jul 8, 2018 · 2 revisions

本項では、info.json ファイルを設置した高度なコマンド作成方法のうち 「ユーザーから情報を取得する方法」について記載しています

ユーザーから情報を取得する(リクエストする)

Qithub コマンドは引数から受け取った情報を元に、実行した結果を出力することしか出来ません。

しかし、info.jsonファイルにてリクエストすることで、以下のようなニーズに対応した高度なコマンドを開発することができます

  • 他の Qithub コマンドを利用したい
  • コマンド・ベースのゲームや WebAPI の AccessToken など、ユーザー側の情報が欲しい
  • ユーザーを識別する ID をコマンドが受け取ることで、特定ユーザーに継続した処理を提供したい
  • Qiitadon や GitHub のアクセス・トークンを受け取ることで、BOT のように Qithub コマンドでユーザーの代理処理を行いたい

その場合「info.json」ファイルに、以下のようにあらかじめ欲しい情報を記載しておくことで、コマンド実行時の引数(Qithub エンコードされた JSON データ)にリクエストした情報を含めてもらうことが期待できます。

{
    "require": {
        "access_token": [...],
        "command": [...],
        "hash": [...]
    }
}

リクエストできる項目

現在は以下の3つの項目をリクエストできます。

  1. Web API 関連のアクセス・トークン
  2. 他の Qithub コマンドの実行結果
  3. コマンドを実行しているユーザーのユーザーID のハッシュ値
Key名 概要 備考
access_token Array アクセス・トークンをリクエスト 現在は Qiita, Qiitadon, GitHub のみ
command Array 他の Qithub コマンドの実行結果をリクエスト
hash Array コマンド実行者を特定するためのリクエスト QiitadonのユーザーIDをハッシュ化した値

各リクエストの詳細に関しては次項をご覧ください。


▶︎ 『アクセス・トークンのリクエスト

Clone this wiki locally