Hatena::Groupatokdirect

ATOKダイレクトAPI:確定情報の利用

ATOKダイレクトAPI:確定情報の利用

確定情報の利用:スクリプトプラグインの詳細情報設定

確定情報を利用するプラグインでは、スクリプトファイルのプラグインと同名のXMLファイルであるスクリプトプラグインの情報ファイルの<plugin_info>に、以下の記述を追加します。

  <callback>true</callback>

確定情報の利用処理実装:Perlの場合

次のような定義を追加します。

sub run_callback
{
  my( $a_request_data ) = @_;
  # ここに行いたい確定情報の利用処理を記述
}

「Atok_Plugin」モジュール内に「run_callback」を実装する必要があります。この処理はプラグインが返した候補が確定されるタイミングで呼び出されます。

「run_callback」の引数で受け取るオブジェクトハッシュで、その構造は以下のようになります。(『文字列』はすべてUTF-8で、utf8フラグが付いています。)

キー種類
candidate_string文字列確定された文字列
composition_string文字列候補検索時に対象とした文字列

確定情報の利用:Rubyの場合

次のような定義を追加します。

def run_callback( a_data )

  # ここに行いたい確定情報の利用処理を記述

end

「Atok_Plugin」モジュール内に「run_callback」を実装する必要があります。この処理はプラグインが返した候補が確定されるタイミングで呼び出されます。

「run_callback」の引数で受け取るオブジェクトはHashで、その構造は以下のようになります。(『String』はすべてUTF-8です。)

キー種類
candidate_stringString確定された文字列
composition_stringString候補検索時に対象とした文字列

確定情報の利用:Pythonの場合

次のような定義を追加します。

def atok_plugin_run_callback( a_data )

  # ここに行いたい確定情報の利用処理を記述

「atok_plugin_run_callback」を実装する必要があります。この処理はプラグインが返した候補が確定されるタイミングで呼び出されます。

「atok_plugin_run_callback」の引数で受け取るオブジェクトはdictで、その構造は以下のようになります。

キー種類
candidate_stringunicode確定された文字列
composition_stringunicode候補検索時に対象とした文字列

※なお、プロキシの情報については、通常の「run_process」メソッドと同様、引数から取得できます。