On this page, we introduce how handlers can be attached to various Kintone events. The different types of Kintone events are listed in the side menu.

Registers an event handler.

kintone.events.on(type, handler)

PARAMETER	VALUE	REQUIRED	DESCRIPTION
type	A string or an array of strings	Yes	The event type or array of event types, to which the event handler will bind to.
handler	Function(Object)	Yes	The handler that will run when the event is triggered. All event objects have an event type in their type property. By returning a kintone.Promise object* in the event handler, the next operations can be processed after waiting for asynchronous processes in the event handler to finish: Record List Events: Onload Event Inline Edit Event Save Event Save Success Event Delete Event Record Details Events: Onload event Delete Event Update Status Event Record Create Events: Onload Event Save Event Save Success Event Record Edit Events: Save Event Save Success Event Onload Event Record Print Events: Onload Event Graph Display Events: Onload Event Portal Display Events: Onload Event *A kintone.Promise object is an object that holds a "then" method. Reference(External site):    https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

Nothing

1
2
3
4
5
6

var handler = function(event) {
  console.log(event);
};
kintone.events.on('app.record.index.show', handler);

kintone.events.on(['app.record.detail.show', 'app.record.edit.show'], handler);

Removes event handlers from the specified event type(s).

kintone.events.off(type, handler)

True, if any event handlers were removed.
False, if no event handlers were removed.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

var handler = function(event) {
  console.log(event);
};
kintone.events.on('app.record.index.show', handler);

// Option 1: Remove the specified handler from the specified event type
kintone.events.off('app.record.index.show', handler);

// Option 2: Remove all handlers from the specified event type
kintone.events.off('app.record.index.show');

// Option 3: Remove all handlers from all event types
kintone.events.off();

• If there are JavaScript files for apps and plug-ins in the same app, the order in which the files are read is as follows:
  • JavaScript files for apps
  • JavaScript files for plug-ins
• Event handlers cannot be overwritten. The existing event handler will need to be deleted, followed by adding a new event handler.
• If there are multiple categories with the same name within the same App, at any of the following events, when returning an object containing the category property, an unintended category may be returned. To avoid this, return the object after deleting the category property.
  Events:
  • Record List Event
    • app.record.index.edit.submit
    • app.record.index edit.change.(field code)
  • Record Create Event
    • app.record.create.show
    • app.record.create.submit
    • app.record.create.change.(field code)
    • mobile.app.record.create.show
    • mobile.app.record.create.submit
    • mobile.app.record.create.change.(field code)
  • Record Edit Event
    • app.record.edit.show
    • app.record.edit.submit
    • app.record.edit.change.(field code)
    • mobile.app.record.edit.show
    • mobile.app.record.edit.submit
    • mobile.app.record.edit.change.(field code)
  • Record Details Event
    • app.record.detail.process.proceed