Get Categories

Get Categories - kintone.app.getCategories()

Retrieves the category settings of the current App.

Function

kintone.app.getCategories()

Parameters

None

Returns

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

Property Type Description
enabled Boolean The status of the category settings.
  • true: the category setting is enabled
  • false: the category setting is disabled
categories Object An object of category settings
categories.{categoryName} Object An object of each category settings.
The default category name is set as the categoryName. This is regardless of the language settings of Kintone.
categories.{categoryName}.name String The category name
categories.{categoryName}.index String The order of the categories in ascending order
categories.{categoryName}.children Object The setting of child categories

Available Pages

  • Record List
  • Record Create
  • Record Edit
  • Record Details
  • Graph