Record Details Events

Onload Event (desktop)app.record.detail.show

Function

Triggered Timing

• After displaying the record details page.
  Note that this also includes timings such as:
  • when viewing the record details page through notifications
  • after displaying the next record by clicking the "next" and "previous" icons
  • after clicking "Save" or "Cancel" on the record edit page
  • after reloading the record details page

Properties of the Event Object

Possible Actions

• Show/Hide fields

Onload Event (mobile)mobile.app.record.detail.show

Function

Triggered Timing

• After displaying the record details page.
  Note that this also includes timings such as:
  • after clicking "Save" or "Cancel" on the record edit page
  • after reloading the record details page

Properties of the Event Object

Possible Actions

• Show/Hide fields

Delete Submit Eventapp.record.detail.delete.submit

Function

Desktop

Mobile

Running actions after waiting for asynchronous operations to finish

By returning a kintone.Promise object, you can delete the record after waiting for asynchronous operations to finish. Refer to the sample code for the "When Clicking the Save Button" event on the Record Create page.

Notes

• If false is returned, the deletion will be cancelled.

Proceed Process Event app.record.detail.process.proceed

Running actions after waiting for asynchronous operations to finish

By returning a kintone.Promise object, you can update the status of the record after waiting for asynchronous operations to finish. Refer to the sample code for the "When Clicking the Save Button" event on the Record Create page.

Notes

• Some processes need several assignees to perform an action before moving onto the next status - this event will take place even when the status does not change.
• The record data can be updated by returning the event object.
• Actions can be cancelled by returning false.
• Actions can be cancelled including an error message, by setting an error property in the event object and returning it. The string in the error property will be displayed as an error message.
• Actions will be canceled with an error, if an invalid value is returned.
• If nothing is returned, only the status will be updated

Function

Desktop

Mobile

// The key of the object 
{value:"action_name"} 　　　　

// The key of the object 
{value:"status_name"}

// The key of the object 
{value:"status_name"}

Possible Actions

• Overwrite field values

Available Actions

Overwrite field values

If the event handler overwrites values in the fields of the record object and returns the event object, the fields of the record are updated with those values in the object.

Sample

When the process has progressed, overwrite the field "text_0" with a specified string, overwrite the first line of the table "Table", and add values into "text_in_table" and "number_in_table" that are inside a table, as a new line.

Note that when adding a new row to the table, all fields in the table must be specified, and the type of each field must also be specified.

Fields that cannot be Overwritten

Even if the below fields are overwritten in the handler and returned, they will not take effect on the record itself.

• Calculated
• The Field Mappings targets of the Lookup field
• Attachment

Notes

• If an empty string is specified for the single-choice field, the default value of the field will be inputted.
• Values of the fields can be overwritten, even if the editing of the field has been disabled.
• If you do not have permission to add values to a particular field, the field change written in the script will not take effect for that field.
• If the handler does not return the event object, the fields will not be updated.
• If there are several handlers, the returned values from the last handler will take effect.

Show/Hide fieldskintone.app.record.setFieldShown()

Function

Desktop

Mobile

Sample

Hiding a field with a field code of "singleline_text0" on the record details page.

The below fields cannot be hidden:

• Label
• Border
• Blank space
• Fields inside tables