jointrashposs/content/ja-JP/.docs-legacy/advanced/plugin-api-reference.md
kakkokari-gtyih a8dca2c347 migrate docs
2023-07-11 00:44:03 +09:00

50 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# プラグインAPIリファレンス
## Mk:dialog(title text type)
ダイアログを表示します。typeには以下の値が設定できます。\
info success warn error question\
省略すると info になります。
## Mk:confirm(title text type)
確認ダイアログを表示します。typeには以下の値が設定できます。\
info success warn error question\
省略すると question になります。\
ユーザーが"OK"を選択した場合は true を、"キャンセル"を選択した場合は false が返ります。
## Mk:api(endpoint params)
Misskey APIにリクエストします。第一引数にエンドポイント名、第二引数にパラメータオブジェクトを渡します。
## Mk:save(key value)
任意の値に任意の名前を付けて永続化します。永続化した値は、AiScriptコンテキストが終了しても残り、Mk:loadで読み取ることができます。
## Mk:load(key)
Mk:saveで永続化した指定の名前の値を読み取ります。
## Plugin:register_post_form_action(title fn)
投稿フォームにアクションを追加します。第一引数にアクション名、第二引数にアクションが選択された際のコールバック関数を渡します。\
コールバック関数には、第一引数に投稿フォームオブジェクトが渡されます。
## Plugin:register_note_action(title fn)
ノートメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。\
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。
## Plugin:register_user_action(title fn)
ユーザーメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。\
コールバック関数には、第一引数に対象のユーザーオブジェクトが渡されます。
## Plugin:register_note_view_interruptor(fn)
UIに表示されるート情報を書き換えます。\
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。\
コールバック関数の返り値でノートが書き換えられます。
## Plugin:register_note_post_interruptor(fn)
ノート投稿時にノート情報を書き換えます。\
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。\
コールバック関数の返り値でノートが書き換えられます。
## Plugin:open_url(url)
第一引数に渡されたURLをブラウザの新しいタブで開きます。
## Plugin:config
プラグインの設定が格納されるオブジェクト。プラグイン定義のconfigで設定したキーで値が入ります。