QuickStart: コンソール(設定や各種特殊機能)を使う

コンソールとは何ですか?

コンソールはTweetIrcGatewayの設定を変更したり、ユーザのフォローやタイムラインの表示、フィルタの設定など色々な機能を使う為の特別なチャンネルです。

目次

IRC クライアントで #Console チャンネルにJOINする

コンソールは #Console という名前のチャンネルですが接続直後にはJOINしていません。そのためまずはクライアントでJOINすることが必要ですのでクライアントでチャンネルを追加してJOINしましょう。

コンテキストと基本的な操作

コンソールは基本的に一行コマンドを入力して結果が表示されるという流れになります。コマンドプロンプトや各種コマンドシェル(IOSやnetshなど)を利用した経験のある方には馴染みやすいでしょう。

またコンソールではコマンドを実行するモードが複数ありコンテキストと呼んでいます。 コンテキストを切り替えることで様々な機能や設定を利用できます。例えばRootコンテキスト(JOIN直後の一番上位に位置するコンテキスト)ではTimelineコマンドやFollowコマンドなどを利用でき、Groupsコンテキストではグループ設定の操作に関するコマンドを利用できるなどです。

コマンド

基本的にコンソールではすべてコマンド入力として扱われます。後に説明する設定項目の表示や設定なども実際はコマンドの一種です。 入力するコマンドは通常以下の形で構成されます。

[コマンド名] [オプション1] [オプション2]...[オプションN]

コマンドの名前を入力し、オプションとして渡したいものがあれば空白で区切って入力します。受け取るオプションはコマンドによって異なり、オプションを必要としないものや必須のものなどがあります。

例えば、Timelineコマンドを利用してaerithさんのタイムラインを表示したいとすると次のようになります。

Timeline aerith

Timelineコマンドはオプションにユーザのスクリーンネームをとるので、コマンド名のあとにスペースを入力しaerithと入力しています。

コマンドのオプションを知りたいときは、Help [コマンド名] と入力することで調べられます。

>Misuzilla< help timeline
<Root> 指定したユーザのタイムラインを取得します
<Root> 引数:
<Root> - screenNames: System.String[]

コンテキスト

コンテキストはコマンドを受け付けるモードのようなもので、各コンテキストごとに受け付けるコマンドや設定項目が異なります。またコンテキストは更に子供のコンテキストを持つ場合があります。

例えば雑多な機能と階層の一番上になるRoot、各種設定を変更するためのConfig、フィルタ設定のためのFilterなどのコンテキストがあります。

利用可能なコマンドとコンテキストの一覧する

現在のコンテキストで利用コマンドと移動できるコンテキストの一覧は Help コマンドで表示できます。

>Misuzilla< help
<Root> [Contexts]
<Root> Config - 設定を行うコンテキストに切り替えます
<Root> Filter - フィルタの設定を行うコンテキストに切り替えます
<Root> Group - グループの設定を行うコンテキストに切り替えます
<Root> System - システムに関連するコンテキストに切り替えます
<Root> DLR - DLR統合 コンテキストに切り替えます
<Root> ShortenUrlService - URL短縮サービスの設定を行うコンテキストに切り替えます
<Root> RevealOnewayFollow - 片思いチェックの設定を行うコンテキストに切り替えます
<Root> [Commands]
<Root> Search - Twitter 検索を利用して検索します
<Root> Timeline - 指定したユーザのタイムラインを取得します
<Root> Favorites - 指定したユーザの Favorites を取得します
<Root> Follow - 指定したユーザを follow します
<Root> Remove - 指定したユーザを remove します
<Root> Block - 指定したユーザを block します
<Root> Unblock - 指定したユーザを unblock します
<Root> Help - コマンドの一覧または説明を表示します
<Root> Show - 設定を表示します
<Root> Set - 設定を変更します
<Root> Unset - 設定をクリアします
<Root> Alias - コマンドのエイリアスを設定します
<Root> Exit - コンテキストを一つ前のものに戻します

[Contexts]以下がコンテキスト、[Commands]以下が利用できるコマンドです。

コンテキストを移動する

コンテキストを移動するにはコンテキスト名を入力します。

>Misuzilla< config
<Root\Config> コンテキストを変更しました。
*names : @misuzillla Help Show Set Unset Alias Exit

コンテキストを抜ける

現在のコンテキストを抜けて、一つ前のコンテキストに戻るには Exit コマンドを利用します。Rootコンテキストは最上位なので抜けることはできません。

>Misuzilla< exit
<Root> コンテキストを変更しました。
*names : @misuzillla Search Timeline Favorites Follow Remove Block Unblock Help Show Set Unset Alias Exit

設定

コンテキストによっては設定項目をもっていて、値を設定できる場合があります。例えばConfigコンテキストなどがその例です。

設定項目を一覧する/設定項目の説明を表示する

現在のコンテキストで設定できる項目を一覧するには Show コマンドを利用します。

>Misuzilla< show
<Root\Config> SearchCount(Int32) = 10
<Root\Config> TimelineCount(Int32) = 10
<Root\Config> FavoritesCount(Int32) = 10
<Root\Config> ShowPermalinkAfterStatus(Boolean) = False
<Root\Config> EnableTypableMap(Boolean) = True
(略)
設定項目の説明を表示する

Show コマンドに項目名を指定するとその項目の説明を表示します。

>Misuzilla< show Interval
<Root\Config> Interval(Int32) = 60
<Root\Config> チェックする間隔を指定します。
設定項目に値を設定する

値を設定するには Set コマンドを利用します。Set コマンドは設定項目名、設定値をとります。

>Misuzilla< set Interval 30
<Root\Config> Interval (Int32) = 30
設定項目に値を削除する

値を削除するには Unset コマンドを利用します。Unset コマンドは設定項目名をとります。なお、Unsetコマンドは値を消したり0にしたりするものでデフォルトに戻すのではないのでご注意ください。

>Misuzilla< show BitlyLogin
<Root\Config> BitlyLogin(String) = a
>Misuzilla< unset BitlyLogin
<Root\Config> BitlyLogin(String) = (null)