イベント処理の記述方法

このページでは、ハンドラーを様々なkumanekoイベントにアタッチする方法を紹介します。

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

構文

pd.event.on(appID, type, handler)

プロパティ

パラメータ名	指定する値	説明
appID	文字列	イベントハンドラーをバインドする対象のアプリIDを指定します。ダッシュボードに関するイベントの場合は「0」固定です。
type	文字列、または文字列の配列	イベントハンドラーをバインドする対象のイベントタイプ、またはイベントタイプの配列を指定します。
handler	関数	イベント発生時に実行されるハンドラーです。イベントのハンドラー内でPromiseオブジェクトをreturnすると、非同期処理の完了を待って次の処理を開始します。

戻り値

ありません。

サンプル

((APP_ID) => {
	"use strict";
	const handler = (event) => {
		console.log(event);
	};
	pd.event.on(APP_ID, 'pd.view.load', handler);
})(pd.APP_ID);

イベントハンドラーを削除する

構文

pd.event.off(appID, type, handler)

プロパティ

パラメータ名	指定する値	説明
appID	文字列	削除対象のイベントハンドラーをバインドしたアプリのアプリIDを指定します。ダッシュボードに関するイベントの場合は「0」固定です。
type	文字列、または文字列の配列	削除対象のイベントハンドラーをバインドしたイベントタイプ、またはイベントタイプの配列を指定します。
handler	関数	削除対象のイベントハンドラーです。バインド時と同一のイベントハンドラーを指定します。

戻り値

ありません。

サンプル

((APP_ID) => {
	"use strict";
	const handler = (event) => {
		console.log(event);
	};
	pd.event.on(APP_ID, 'pd.view.load', handler);

	pd.event.off(APP_ID, 'pd.view.load', handler);
})(pd.APP_ID);