イベント処理の記述方法

フォローする

Index

イベント処理の概要

kintone で発生する様々なイベントについて、ハンドラーを紐付けして実行することができます。

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

  • PC用とスマートフォン用で利用できます。
  • 全ての画面(アプリ、スペースも含む)で利用できます。※ただしスペースの本文に貼りつけたアプリでは利用できません。

関数

kintone.events.on(event, handler(event))

プロパティ

パラメータ名 指定する値 必須 説明
event 文字列 または 文字列の配列 必須 イベントハンドラーをバインドする対象のイベントタイプ、またはイベントタイプの配列を指定します。
handler(event) Function(Object) 必須

イベント発生時に実行されるハンドラーです。eventオブジェクトは共通でtypeプロパティにイベントタイプを持ちます。

下記のイベントのハンドラー内でkintone.Promiseオブジェクト※ をreturnすると、非同期処理の実行を待ってイベントの処理を開始します。

※kintone.Promiseオブジェクトは、thenメソッドを持っているオブジェクトです。
▼参考(外部サイト)
https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Promise

戻り値

ありません。

サンプルプログラム

特定のイベントタイプ内の特定のイベントハンドラーを削除する

  • PC用とスマートフォン用で利用できます。
  • 全ての画面(アプリ、スペースも含む)で利用できます。※ただしスペースの本文に貼りつけたアプリでは利用できません。

関数

kintone.events.off(event, handler(event))

プロパティ

パラメータ名 指定する値 必須 説明
event 文字列 または 文字列の配列 必須 削除対象のイベントハンドラーを登録したイベントタイプ、またはイベントタイプの配列を指定します。
 handler(event) Function(Object) 必須 削除対象のイベントハンドラーです。 イベント登録時と同一のオブジェクトを指定します。

戻り値

  • true:一つでも削除に成功した場合
  • false:削除対象のイベントハンドラーが1つも見つからなかった場合

サンプルプログラム

特定のイベントタイプ内のすべてのイベントハンドラーを削除する

  • PC用とスマートフォン用で利用できます。
  • 全ての画面(アプリ、スペースも含む)で利用できます。※ただしスペースの本文に貼りつけたアプリでは利用できません。

関数

kintone.events.off(event)

プロパティ

パラメータ名 指定する値 必須 説明
event 文字列 または 文字列の配列 必須 削除対象のイベントハンドラーを登録したイベントタイプ、またはイベントタイプの配列を指定します。

戻り値

  • true:一つでも削除に成功した場合
  • false:削除対象のイベントハンドラーが1つも見つからなかった場合

サンプルプログラム

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

  • PC用とスマートフォン用で利用できます。
  • 全ての画面(アプリ、スペースも含む)で利用できます。※ただしスペースの本文に貼りつけたアプリでは利用できません。

関数

kintone.events.off()

戻り値

  • true:1つでも削除された場合
  • false:削除対象のイベントハンドラーが1つも見つからなかった場合

注意事項

  • 同じアプリにアプリのJavaScriptファイル、プラグインのJavaScriptファイル両方を設定した場合、アプリのJavaScriptファイル、プラグインのJavaScriptファイルの順に読み込まれます。
  • イベントハンドラは追加されていくだけで上書きされることはありません(これはJavaScript全般の仕様でkintone JavaScript APIを使う場合も同様です。)。
    上書きをしたい場合は、設定済みのイベントハンドラを削除したのちに、新しいイベントを登録する処理が必要となります。

コメント

Avatar
Hirano Hiroyoshi

kintoneイベント 「スペースに貼りつけたアプリでは利用できません。」とありますが
スペースではjavascriptを組み込めないということでしょうか?
一部、詳細画面表示時にボタン貼付して処理を行っているのですが
正しく動作していますが・・・

Avatar
門屋 亮

おそらく、スペースの本文へのアプリ貼り付けのことを言っているのだと思います。
https://help.cybozu.com/ja/k/user/paste_app.html

Avatar
Hirano Hiroyoshi

門屋様

「スペースの本文への」ですっきりしました。
ありがとうございます。

Avatar
mharum

kintone.Promise対応のイベントを最新化して頂けると助かります。

ログインしてコメントを残してください。
Powered by Zendesk