API Docs

Get User Preference

Get User Preference kintone.getUserPreference()

Retrieves the personal settings of the logged-in user.

Function

kintone.getUserPreference()

Parameters

None

Returns

A Promise object.
The following values can be retrieved when the Promise object is fulfilled:

Property Type Value and Description
timeFormat String The Time format settings
  • TWELVE: 12-hour format
  • TWENTY_FOUR: 24-hour format
desktopNotifications Object The Desktop notification settings
desktopNotifications.enabled Boolean The status of the Desktop notifications settings
  • true: Enabled
  • false: Disabled
emailNotifications Object Email notification settings
emailNotifications.enabled Boolean The status of the Email notifications settings
  • true: Receive
  • false: Do not receive
emailNotifications.condition String The condition of the email notifications
  • TO_ME: Notifications addressed to the user
  • ALL: All notifications
Even if emailNotifications.enabled is false, the value will still be returned.
emailNotifications.format String The format of the email notifications
  • HTML: HTML format
  • TEXT: Text format
Even if emailNotifications.enabled is false, the value will still be returned.

Available Pages

However, it cannot be used on the following pages:

  • Search results
  • Marketplace
  • Plug-in settings page