イベント処理の概要

@pocketのイベントシステムは、特定のイベントが発火した際に、事前に登録された処理を実行する形で動作します。

イベントの基本動作

@pocketのイベント処理は、以下のような基本構造を持っています。

イベントリスナーは、第一引数にイベント名、第二引数にコールバック関数を指定して登録します。コールバック関数の引数には、イベントオブジェクトが渡されます。

イベントオブジェクトは各イベントごとに異なるデータを持ちます。

atPocket.events.on('app.record.edit.show', (event) => {
  console.log(event.appId, event.recordId);
  return event;
});

レコードの画面で発火するイベント名には、画面を表す {action} が含まれます。

作成画面と編集画面の両方で同じ処理を行いたい場合は、イベント名を配列で指定します。

atPocket.events.on(['app.record.create.show', 'app.record.edit.show'], (event) => {
  return event;
});

イベントハンドラーの中から atPocket.app.record.set() を呼び出すことはできません。値を変更する場合は、引数のイベントオブジェクトの record を書き換えて return してください。

atPocket.events.on('app.record.edit.change', (event) => {
  event.record['field-3'].value = '計算結果';
  return event;
});

詳しくはレコードへの値の反映を参照してください。

イベントハンドラーは、配信されるカスタマイズ JS ／プラグインのファイル単位で分離されます。