What are Kintone Plug-ins?
Kintone plug-ins are packaged customization files that can be imported into a Kintone environment, and installed into any App. Plug-ins provide an easy way for users to set up customizations in Kintone without having to touch or alter any code.
Develop a Kintone Plug-in
Next, prepare an environment for developing plug-ins by following the Plug-in development environment article.
Finally, read through the Steps for plug-in development article for in-depth details on the necessary files within a Kintone plug-in and how to package the final file.
setConfig() is used to save user input data on the plug-in settings page. The saved data can then be called using the getConfig() method. For example, in the case of a plug-in that changes the background color of a field when it equals a particular value, a drop-down element with various color choices may exist in the plug-in settings page. When a user selects the color from the drop down element and clicks the save button, setConfig() should be executed to save the selected value.
getConfig() is used to retrieve the values saved with the setConfig() method. In the case of the background-color plug-in described above, getConfig() should be executed during an event such as the Record List Onload Event. Doing so will retrieve the saved values that can be inputted into a function to change the field background color.
proxy() is used to run 3rd party REST APIs. If it is necessary to utilize plug-in setting values with a 3rd party REST API, the settings must be saved with the setProxyConfig() method. Note that this API is different from the Kintone Proxy API.
setProxyConfig() is similar in function to the setConfig() method, as it saves user inputs on the plug-in settings page. However, setProxyConfig() is to be used with the above proxy() method for 3rd party REST APIs. This method is commonly used to save usernames and passwords or API keys to use for authentication with 3rd party services.
getProxyConfig() is similar in function to the getConfig() method, as it retrieves user inputs saved on the plug-in settings page. However, getProxyConfig() only retrieves values saved with the setProxyConfig() method, and can only be used on the Plug-in settings page.
proxy.upload() allows the user to upload a file to outside of Kintone using a plug-in. If the external REST API requires sending authentication information with the file data, use data saved with the setProxyConfig() method.