関西弁のドキュメントは作ってないで

さすがに関西弁のドキュメントを用意するのは大変やから、標準語の内容と同じにしてあんで。ごめんな。

AiScript Misskey拡張API リファレンス

ここでは、Misskeyで独自に拡張されたAiScript APIについて紹介しています。

ヒント

標準装備のAiScript APIはこちらからご覧いただけます。

全分野共通定数

USER_ID

現在のユーザーのID

USER_NAME

現在のユーザーの名前

USER_USERNAME

現在のユーザーのハンドル(@より後ろの部分。例: @[email protected]ai

CUSTOM_EMOJIS

カスタム絵文字の一覧。以下のようなオブジェクトが配列で格納されています

type EmojiSimple = {
  aliases: string[];
  name: string;
  category: string | null;
  url: string;
  localOnly?: boolean;
  isSensitive?: boolean;
  roleIdsThatCanBeUsedThisEmojiAsReaction?: string[];
}

LOCALE

現在のMisskey Webの設定言語。RFC4646互換の形式(ja-JPなど)で表されます

SERVER_URL

現在のサーバーのURL。https://www.example.com のようにオリジンで表されます

全分野共通関数

Mk:dialog(title, text, type)

ダイアログを表示します。typeには以下の値が設定できます。
info success warning error question
省略すると info になります。

Mk:confirm(title, text, type)

確認ダイアログを表示します。typeには以下の値が設定できます。
info success warning error question
省略すると question になります。
ユーザーが"OK"を選択した場合は true を、"キャンセル"を選択した場合は false が返ります。

let response = Mk:confirm(
  '操作を続行しますか?'
  'この操作は取り消せません。よく確認してください。'
  'warning'
)

if (response) {
  // OKした場合
} else {
  // キャンセルした場合
}

Mk:api(endpoint, params, token?)

Misskey APIにリクエストします。第一引数にエンドポイント名、第二引数にパラメータオブジェクトを渡します。

第三引数にtokenを入れることもできます。プラグインで動作する場合は、引数指定無しでログイン中のユーザーのtokenが使用されます。

Mk:save(key, value)

任意の値に任意の名前を付けて永続化します。永続化した値は、AiScriptコンテキストが終了しても残り、Mk:loadで読み取ることができます。

Mk:load(key)

Mk:saveで永続化した指定の名前の値を読み取ります。

プラグイン専用

Plugin:register_post_form_action(title, fn)

投稿フォームにアクションを追加します。第一引数にアクション名、第二引数にアクションが選択された際のコールバック関数を渡します。
コールバック関数には、第一引数に投稿フォームオブジェクトのうちtextcwが、第二引数にそれらを書き換えるための関数が渡されます。

Plugin:register_post_form_action('メニューに表示される項目名', @(note, rewrite) {

  // ノートに何らかの変更を加える
  rewrite('text', `{note.text}{Str:lf}#ハッシュタグ`)
})

Plugin:register_note_action(title, fn)

ノートメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。

Plugin:register_note_action('メニューに表示される項目名', @(note) {

  // ノートを使って何かする
  Mk:api('notes/create', {
    text: '引用'
    renoteId: note.id
  })

})

Plugin:register_user_action(title, fn)

ユーザーメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。
コールバック関数には、第一引数に対象のユーザーオブジェクトが渡されます。

Plugin:register_user_action('メニューに表示される項目名', @(user) {

  // ユーザー情報を使って何かする
  Mk:api('notes/create', {
    text: `{user.name}さん、ようこそ!`
  })

})

Plugin:register_note_view_interruptor(fn)

UIに表示されるノート情報を書き換えます。
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。
コールバック関数の返り値でノートが書き換えられます。
null を返すとそのノートを非表示にします。

Plugin:register_note_view_interruptor(@(note) {
  
  // ノートの中身を書き換える
  note.text = note.text.replace('リンゴ', 'バナナ')

  // nullを返すと非表示
  if (note.text.incl('納豆')) {
    return null
  }

  return note
})

Plugin:register_note_post_interruptor(fn)

ノート投稿時にノート情報を書き換えます。
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。
コールバック関数の返り値でノートが書き換えられます。

Plugin:register_note_post_interruptor(@(note) {
  
  // ノートの中身を書き換える
  note.text = note.text.replace('リンゴ', 'バナナ')

  return note
})

Plugin:register_page_view_interruptor(fn)

Page閲覧時にPage情報を書き換えます。
コールバック関数には、第一引数に対象のPageオブジェクトが渡されます。
コールバック関数の返り値でPageが書き換えられます。

Plugin:register_note_post_interruptor(@(page) {
  
  // ページの中身を書き換える(省略)

  return page
})

Plugin:open_url(url)

第一引数に渡されたURLをブラウザの新しいタブで開きます。

Plugin:config

プラグインの設定が格納されるオブジェクト。プラグイン定義のconfigで設定したキーで値が入ります。

Play専用 定数

THIS_ID

PlayのID

THIS_URL

PlayのURL

UI制御関数(Play・AiScript Appウィジェットで使用可能)

Ui:root

UIのルート要素。

Ui:render([ ...components ])

Ui:root.update({ children: [ ...components ] }) の糖衣構文。UIのルート要素を書き換えます。

Ui:render([
  Ui:C:text({text: "A"})
  Ui:C:button({text: "B", onClick: @(){}})
])

Ui:get(id)

IDを付与したコンポーネントを取得し、操作を行えます。

Ui:C:text({text: "A"}, "text1")
Ui:get("text1").update({text: "B"})

コンポーネント関数(Play・AiScript Appウィジェットで使用可能)

以下の要素では、初期化の際に Ui:C:xxx(props id) のように第2引数にコンポーネントのidを指定することができます(以下のリファレンスではすべて省略しています)。指定したidは Ui:get(id) 関数で取得でき、update 関数でコンポーネントの中身を直接変更することができます(詳しくは Ui:get(id) のリファレンスをご覧ください)。

レイアウト

Ui:C:container

幅寄せ、色などの書式設定ができる外枠(コンテナ)

Ui:C:container({
  children: [
    // コンテナの中に入れたいコンポーネントの配列
    Ui:C:text({text: "A"})
  ]
  align: 'center' // 幅寄せ left,center,right
  bgColor: '#000' // 背景色
  fgColor: '#00f' // 文字色
  font: 'serif' // フォント serif,sans-serif,monospace
  borderWidth: 1 // 枠幅
  borderColor: '#f00' // 枠の色
  padding: 1 // 余白幅
  rounded: false // 角を丸く
  hidden: false // 隠す
})

Ui:C:folder

アコーディオン要素(ユーザーが開けたり閉めたりできるコンテナ)

Ui:C:folder({
  children: [
    // コンテナの中に入れたいコンポーネントの配列
    Ui:C:text({text: "A"})
  ]
  title: "タイトル" // フォルダの開閉部分に記載するタイトル
  opened: true // はじめから開いているか
})

テキスト

Ui:C:text

プレーンテキスト

Ui:C:text({
  text: "内容" // 表示するテキスト
  size: 1 // 文字サイズ
  bold: false // ボールド
  color: '#000' // 色
  font: 'monospace' // フォント serif,sans-serif,monospace
})

Ui:C:mfm

MFMテキスト

Ui:C:mfm({
  text: "内容" // 表示するテキスト
  size: 1 // 文字サイズ
  bold: false // ボールド
  color: '#000' // 色
  font: 'monospace' // フォント serif,sans-serif,monospace
  onClickEv: @(id) {
    // $[clickable.ev=eventId TEXT] のMFM構文のハンドラ
    <: `{id} clicked`
  }
})

フォーム

Ui:C:button

ボタン

Ui:C:button({
  text: "ボタン" // ボタンに表示するテキスト
  onClick: @() {
    // 押したときのイベント
  }
  primary: false // 色を付けるか?
  rounded: false // 角を丸くするか?
  disabled: false // 無効化するか?
})

Ui:C:buttons

ボタン(横並び)

Ui:C:buttons({
  buttons: [ // ボタン定義の配列。propsの指定形式は Ui:C:button と同じ
    {text: "a", onClick: @(){...}}
    {text: "b", onClick: @(){...}}
  ]
})

Ui:C:switch

Ui:C:switch({
  onChange: @(enabled) { 
    // 変更された時のイベント。第1引数に変更後の状態(boolean)
  }
  default: false // デフォルト値
  label: "ラベル" // スイッチ横のテキスト
  caption: "キャプション" // スイッチ下に表示する補助テキスト
})

Ui:C:textInput

1行のテキスト入力

Ui:C:textInput({
  onInput: @(text) {
    // 入力された時のイベント。第1引数に変更後の値
  }
  default: "デフォルト" // デフォルト値
  label: "ラベル" // 入力欄上のテキスト
  caption: "キャプション" // 入力欄下に表示する補助テキスト
})

Ui:C:numberInput

1行のテキスト入力

Ui:C:numberInput({
  onInput: @(number) {
    // 入力された時のイベント。第1引数に変更後の値
  }
  default: "デフォルト" // デフォルト値
  label: "ラベル" // 入力欄上のテキスト
  caption: "キャプション" // 入力欄下に表示する補助テキスト
})

Ui:C:textarea

複数行のテキスト入力

Ui:C:textarea({
  onInput: @(text) {
    // 入力された時のイベント。第1引数に変更後の値
  }
  default: "デフォルト" // デフォルト値
  label: "ラベル" // 入力欄上のテキスト
  caption: "キャプション" // 入力欄下に表示する補助テキスト
})

Ui:C:select

複数の値から一つ選ぶ形式

Ui:C:select({
  items: [ // 選択肢の配列。textには表示するテキストを、valueには変更時のイベントで渡す値を入力
    {text: "A", value: "v1"}
    {text: "B", value: "v2"}
  ]
  onChange: @(value){
    // 変更された時のイベント。第1引数に変更後のvalue
  }
  default: "v1" // デフォルトのvalue
  label: "ラベル" // 入力欄上のテキスト
  caption: "キャプション" // 入力欄下に表示する補助テキスト
})

ノート投稿関連

Ui:C:postForm

投稿フォームをPlayに直接埋め込む

Ui:C:postForm({
  form: {
    cw: "CW注釈" // CWを指定する場合の「要約」テキスト
    text: "投稿内容" // 投稿フォームのデフォルト文字列

    // 以下はMisskey v2024.5.0以降で指定可能となります
    visibility: "home" // デフォルトの投稿の公開範囲(未指定の場合はpublic)
    localOnly: false // デフォルトで連合無しかどうか(未指定の場合はfalse)
  }
})

Ui:C:postFormButton

投稿フォームを呼び出せる特殊ボタン

Ui:C:postFormButton({
  text: "投稿!" // ボタンに表示するテキスト
  primary: false // 色を付けるか?
  rounded: false // 角を丸くするか?
  form: {
    cw: "CW注釈" // CWを指定する場合の「要約」テキスト
    text: "投稿内容" // 投稿フォームのデフォルト文字列

    // 以下はMisskey v2024.5.0以降で指定可能となります
    visibility: "home" // デフォルトの投稿の公開範囲(未指定の場合はpublic)
    localOnly: false // デフォルトで連合無しかどうか(未指定の場合はfalse)
  }
})