Garoon APIドキュメント

イベント処理の記述方法

目次

イベントハンドラーを登録する

固定リンクがコピーされました

Garoonで発生するさまざまなイベントとイベントハンドラーを紐付けると、任意の処理を実行できます。

関数

固定リンクがコピーされました

garoon.events.on(type, handler)

引数

固定リンクがコピーされました

パラメーター名 型 必須 説明
type 文字列または配列（文字列） 必須 イベントハンドラーを紐付けるイベントのタイプ
イベントごとに異なります。詳しくは、それぞれのイベントページを確認してください。
handler 関数 必須 イベント発生時に実行されるイベントハンドラー
イベントハンドラーの引数として渡されるイベントオブジェクトは、イベントごとに異なります。詳しくは、それぞれのイベントページを確認してください。
Promiseに対応したイベントの場合、イベントハンドラーの内で garoon.Promiseオブジェクト をreturnすることで、非同期処理の完了を待ってからフォームの値に応じた制御ができます。

データのバリデーション

固定リンクがコピーされました

次の項目タイプの値を変更する場合、不正な値かどうかがチェックされます。

  • 日付
  • 日時
  • ラジオボタン
  • メニュー
  • チェックボックス

次のいずれかに当てはまる場合には、エラーが表示され、すべての項目で変更が失敗します。

  • フォーマットが正しくない。
  • 設定にラジオボタンの値が存在しない。
  • チェックボックスの値が真偽値でない。
  • 日付または日時の場合、次のいずれかに該当する。
    • 年、月、日が有効データではない。
    • 「null」または「--」ではない。
    • 年に、1970年以前、または2037年以降が設定されている。

戻り値

固定リンクがコピーされました

なし

サンプルコード

固定リンクがコピーされました

1
2
3
4
5
6
7
8
9

garoon.events.on('workflow.request.create.show', (event) => {
  console.log(event);
});

// 複数のイベントで、同じイベントハンドラーを登録する場合
const events = ['workflow.request.create.show', 'workflow.request.detail.show'];
garoon.events.on(events, (event) => {
  console.log(event);
});