Hedgehog SDK

Appearance

Return to top
On this page

stage.ref.event.ref.message

メッセージに関する操作です。

メソッド

create()

引数必須型内容
data✓CreateMessageInput作成データ
type
Promise<MessageRefference> →

メッセージを作成します。

INFO

管理者投稿をする場合は、管理者としてログインしている必要があります。

使用方法

ts
// チケット番号無し
const message = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.ref("イベントのUUID")
  .message()
  .create({
    message: "メッセージ",
  });

//チケット番号あり
const messageWithTicket = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.ref("イベントのUUID")
  .message()
  .setTicketNumber("チケット番号")
  .create({
    message: "メッセージ",
  });

cursor()

type
MessageListCursor →

メッセージリスト用のカーソルオペレータを取得します。

使用方法

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

observe()

引数必須型内容
addedListener✓(Message) => voidメッセージ追加時のコールバック。
removedListener✓(Message) => voidメッセージ削除時のコールバック。
modifiedListener✓(Message) => voidメッセージ修正時のコールバック。※ 前方互換性のための実装であり、現状では呼び出されません。
type
MessageObserver →

メッセージの変更監視オペレータを取得します。取得と同時に監視が開始されます。

使用方法

ts
const observer = Hedgehog.stage
  .ref("ステージのUUID")
  .event.ref("イベントのUUID")
  .message()
  .observe(
    (m) => {
      /** 追加時の処理 */
    },
    (m) => {
      /** 更新時の処理 */
    },
    (m) => {
      /** 削除時の処理 */
    }
  );

ref()

引数必須型内容
uuid✓stringメッセージの UUID

UUID からメッセージの参照を取得します。

使用方法

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

setTicketNumber()

チケット番号をセットし、自身への参照を返します。

INFO

チケット番号で保護されたイベントに対しての操作には、チケット番号が必要です。