stage.ref.event

イベントに関する操作です。

プロパティ

type

要認証エリアへのアクセスです。

引数	必須	型	内容
id	✓	`string`	一意なユーザー設定ID

type

boolean

可読IDが使用可能かどうかを取得します。

INFO

可読ID(readableId)は、Hedgehog内の全イベントの中で一意である必要があります。

使用方法

const available = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.checkAvaivalityOfReadableId("可読ID");

引数	必須	型	内容
readableId	✓	`string`	可読ID

type

可読ID からイベントの参照を取得します。

使用方法

const event = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.fromReadableId("イベントの可読ID");

引数	必須	型	内容
option		`LiveEventListOption`	リスト取得時のオプション

type

イベントのリストオペレータを取得します。

使用方法

// すべて取得する場合
const list = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.list({
    /** 取得条件 */
  })
  .all();

引数	必須	型	内容
uuid	✓	`string`	イベントの UUID

type

UUID からイベントの参照を取得します。

使用方法

const event = Hedgehog.stage
  .ref("ステージのUUID")
  .event.ref("イベントのUUID");