リファレンス

public Turboism SDK のガイド付き reference と生成済み reference。

Reference section では、plugin-facing SDK boundary を説明します。

ここから始める

  • SDK API ガイド — lifecycle、PluginContext、object API、hook、configuration、storage、task、UI、permission、readiness constraint。
  • 生成済み API reference — public SDK package の source-generated JDK 17 Javadoc と、その公開状況。
  • HTML type index を開く — package、class、record、interface、method を直接閲覧する。

契約の状態

Turboism は単一の public SDK 階層を公開します。Turboism の source repository(sdk/api-contracts/baselines/)にあるレビュー済みバイナリ API ベースラインが compatibility gate です。現在のベースラインが有効な正確なゲートであり、以前のベースラインは履歴監査として残ります。

利用可否は引き続き別々の事実に依存し、1 つを満たしても別の 1 つが成立するものではありません。

  1. SDK に API が存在する。
  2. plugin が必要な permission を宣言している。
  3. Runtime に一致する capability Provider がある。
  4. 使用中の Cubism Editor のバージョンと object generation がサポートされている。

Internal Runtime、Bootstrap、test-framework、mapping、Provider、first-party plugin implementation package は、意図的に public reference から除外されています。