リファレンス · 開発チーム向け連携ガイド
Shortform event
開発チームが連携を適用する際に参照するガイドです。管理画面の運用には必要ありません。
Shortform event によるコメント登録の通知
Shortform で発生する event message のうち DETAIL_CREATE_COMMENT / DETAIL_UPDATE_COMMENT / DETAIL_DELETE_COMMENT を通じて、コメントの登録/修正/削除時に別の動作を行えるよう、addShortformEventListener() で定義したコールバック関数を登録できます。
その他のイベントは Shortform Events ドキュメントを参照
- addShortformEventListener() で定義したコールバックを実行し、受け取ったイベントメッセージに応じた動作を実装します。
- DETAIL_CREATE_COMMENT / DETAIL_UPDATE_COMMENT / DETAIL_DELETE_COMMENT でコメントの登録/修正/削除に関するイベントを受け取ります。
- payload で渡された情報から、イベントに関連する Shortform、Comment の情報を受信します。
Event Message と payload の仕様
| Message | Description |
|---|---|
| DETAIL_CREATE_COMMENT | コメントの登録 |
| DETAIL_UPDATE_COMMENT | コメントの修正 |
| DETAIL_DELETE_COMMENT | コメントの削除 |
| Payload | Type |
|---|---|
| shorts | Shorts |
| comment | Comment |
例
<script type="text/javascript" src="https://static.shoplive.cloud/shoplive-shortform.js"></script>
<script>
// Initialize
cloud.shoplive.initShortform({ accessKey: 'YOUR ACCESS KEY HERE' });
// Shortform event listener
const listener = (message, payload) => {
switch(message) {
case "DETAIL_CREATE_COMMENT":
console.log("User creates comment : ", payload);
//内部ロジックで Shortform の登録を通知
...
break;
case "DETAIL_UPDATE_COMMENT":
console.log("User updated comment : ", payload);
//内部ロジックで Shortform の修正を通知
...
break;
case "DETAIL_DELETE_COMMENT":
console.log("User deleted comment : ", payload);
//内部ロジックで Shortform の削除を通知
...
break;
}
}
// Add event listener
cloud.shoplive.addShortformEventListener(listener);
</script>
関連ドキュメント:
- Shortform のイベントをトラッキングする
- Shortform Events