stage.ref.event.list

イベントのリストオペレータです。

メソッド

type

Promise<Array<LiveEvent>>

全てのリストを取得します。

使用方法

  const list = await Hedgehog.stage.ref("ステージのUUID").event.list().all();

type

Promise<(LiveEvent|undefined)>

リストの最初の要素を取得します。

使用方法

  const data = await Hedgehog.stage.ref("ステージのUUID").event.list().first();

引数	必須	型	内容
limit	✓	`number`	1 ページ当たりの要素数
page	✓	`number`	取得するページ

type

Promise<LiveEvent>

ページに分けてリストを取得します。

使用方法

const list = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.list()
  .page(10, 1);

引数	必須	型	内容
order	✓	`LiveEventSort` / `Array<LiveEventSort>`	ソート用データ

type

取得するリストに対するソートをセットします。