パッケージ hajimeapi4j.api.endpoint

インタフェース TaxEndPoint

すべてのスーパーインタフェース:
EndPoint, RestAction<EndPoint>
既知の実装クラスのリスト:
TaxEndPointImpl
public interface TaxEndPoint extends EndPoint
エンドポイント「/tax」にて取得できる情報を定義したインターフェースです

taxエンドポイントでは要求するデータタイプによって取得できる情報が多岐にわたるため、それぞれのGetterメソッドのドキュメントで取得できるtype情報などを羅列しています。

導入されたバージョン:
5.0.0.0-Alpha.1
関連項目:

  • メソッドの詳細

    • getKana

      Optional<String> getKana()
      読み仮名情報を取得します。

      取得可能カテゴリタイプ

      • idol
      • unit
      戻り値:
      読み仮名情報。エラーなどで情報が取得できなかった場合、対応していない出力モードの場合は Optional.empty()

    • getCv

      Optional<String> getCv()
      声優名情報を取得します。

      取得可能カテゴリタイプ

      • idol
      戻り値:
      声優名情報

    • getCvKana

      Optional<String> getCvKana()
      声優名の読み仮名情報を取得します。

      取得可能カテゴリタイプ

      • idol
      戻り値:
      声優名の読み仮名情報

    • getProduction

      Optional<String> getProduction()
      アイドルの所属プロダクション情報を取得します。

      取得可能カテゴリタイプ

      • idol
      戻り値:
      アイドルの所属プロダクション情報

    • getDate

      Optional<String> getDate()
      ライブの開催日時情報を取得します。「yyyy-mm-dd」形式。

      取得可能カテゴリタイプ

      • live
      戻り値:
      ライブの開催日時情報

    • getPlace

      Optional<String> getPlace()
      ライブの会場情報を取得します。

      取得可能カテゴリタイプ

      • live
      戻り値:
      ライブの会場情報

    • getMember

      Optional<List<Member>> getMember()
      歌唱曲、もしくはライブ披露時の参加メンバーを取得します。

      取得可能カテゴリタイプ

      • live
      • unit
      戻り値:
      参加メンバー、ユニットメンバー情報

    • getSetlist

      Optional<Boolean> getSetlist()
      ライブなどで披露した際のセットリスト情報がデータベースに存在するかどうかを取得します。

      取得可能カテゴリタイプ

      • live
      戻り値:
      セットリストの有無

    • getLyrics

      Optional<EndPoint> getLyrics()
      同じ名義などで作業した楽曲一覧を表示するためのカテゴリ情報を出力します。

      同じ名義で作詞を行った情報を返却します

      取得可能カテゴリタイプ

      • lyrics
      戻り値:
      同じ名義で作詞を行った楽曲情報

    • getComposer

      Optional<EndPoint> getComposer()
      同じ名義などで作業した楽曲一覧を表示するためのカテゴリ情報を出力します。

      同じ名義で作曲を行った情報を返却します

      取得可能カテゴリタイプ

      • composer
      戻り値:
      同じ名義で作曲を行った楽曲情報

    • getArrange

      Optional<EndPoint> getArrange()
      同じ名義などで作業した楽曲一覧を表示するためのカテゴリ情報を出力します。

      同じ名義で編曲を行った情報を返却します

      取得可能カテゴリタイプ

      • arrange
      戻り値:
      同じ編曲で作詞を行った楽曲情報

    • getSong

      @Nonnull List<Song> getSong()
      楽曲情報の出力を行います
      戻り値:
      指定された楽曲情報