API Docs

Get Config

Get Config - kintone.plugin.app.getConfig()

Retrieves the plug-in configuration settings.

Function

kintone.plugin.app.getConfig(pluginId)

Parameters

PARAMETER TYPE REQUIRED DESCRIPTION
pluginId String Yes Specify the plug-in ID of the plug-in you want to retrieve details from.

Returns

An object with the plug-in settings information will be returned, with the key and the value as a set.
Null is returned when it cannot be used.

Available Pages

This method can be used on the following pages:

Desktop pages:

  • Record List
  • Record Details
  • Record Create
  • Record Edit
  • Graph
  • Plug-in Settings

Mobile pages:

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

Sample Request 

1
2
3
4
5
6
7
8

var config = kintone.plugin.app.getConfig('ghjdjfpgeoghqsmczgajibgpxoffmgaa');
console.log(config);

// returns
// {
//  "Number Field Code": "number_field",
//  "Font Color": "#8bc534"
// }