com.kintone.client

Class PluginClient

Object

PluginClient

public class PluginClient
extends Object

A client that operates plugin APIs.

Method Summary

Modifier and Type	Method and Description
GetAppsResponseBody	getApps(GetAppsRequest request) Gets the list of Apps that have the specified Plug-in added.
List<App>	getApps(String id) Gets the list of Apps that have the specified Plug-in added.
List<App>	getApps(String id, Long offset, Long limit) Gets the list of Apps that have the specified Plug-in added.
GetInstalledPluginsResponseBody	getInstalledPlugins() Gets the list of plug-ins imported into Kintone.
GetInstalledPluginsResponseBody	getInstalledPlugins(GetInstalledPluginsRequest request) Gets the list of plug-ins imported into Kintone.
GetInstalledPluginsResponseBody	getInstalledPlugins(Long offset, Long limit) Gets the list of plug-ins imported into Kintone.
List<Plugin>	getRequiredPlugins() Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.
GetRequiredPluginsResponseBody	getRequiredPlugins(GetRequiredPluginsRequest request) Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.
List<Plugin>	getRequiredPlugins(Long offset, Long limit) Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.
InstallPluginResponseBody	installPlugin(InstallPluginRequest request) Installs a Plug-in into Kintone.
InstallPluginResponseBody	installPlugin(String fileKey) Installs a Plug-in into Kintone.
void	uninstallPlugin(String id) Uninstalls a Plug-in from the Kintone environment.
UninstallPluginResponseBody	uninstallPlugin(UninstallPluginRequest request) Uninstalls a Plug-in from the Kintone environment.
UpdatePluginResponseBody	updatePlugin(String id, String fileKey) Updates an installed Plug-in in the Kintone environment.
UpdatePluginResponseBody	updatePlugin(UpdatePluginRequest request) Updates an installed Plug-in in the Kintone environment.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstalledPlugins

public GetInstalledPluginsResponseBody getInstalledPlugins()

Gets the list of plug-ins imported into Kintone.

Returns:

the response data. See GetInstalledPluginsResponseBody

getInstalledPlugins

public GetInstalledPluginsResponseBody getInstalledPlugins(Long offset,
                                                           Long limit)

Gets the list of plug-ins imported into Kintone.

Parameters:

offset - The number of plug-ins to skip from the list of installed plug-ins.

limit - The maximum number of plug-ins to retrieve.

Returns:

the response data. See GetInstalledPluginsResponseBody

getInstalledPlugins

public GetInstalledPluginsResponseBody getInstalledPlugins(GetInstalledPluginsRequest request)

Gets the list of plug-ins imported into Kintone.

Parameters:

request - the request parameters. See GetInstalledPluginsRequest

Returns:

the response data. See GetInstalledPluginsResponseBody

installPlugin

public InstallPluginResponseBody installPlugin(String fileKey)

Installs a Plug-in into Kintone.

Parameters:

fileKey - the fileKey representing an uploaded file.

Returns:

the response data. See InstallPluginResponseBody

installPlugin

public InstallPluginResponseBody installPlugin(InstallPluginRequest request)

Installs a Plug-in into Kintone.

Parameters:

request - the request parameters. See InstallPluginRequest

Returns:

the response data. See InstallPluginResponseBody

uninstallPlugin

public void uninstallPlugin(String id)

Uninstalls a Plug-in from the Kintone environment.

Parameters:

id - the Plug-in ID.

uninstallPlugin

public UninstallPluginResponseBody uninstallPlugin(UninstallPluginRequest request)

Uninstalls a Plug-in from the Kintone environment.

Parameters:

request - the request parameters. See UninstallPluginRequest

Returns:

the response data. See UninstallPluginResponseBody

updatePlugin

public UpdatePluginResponseBody updatePlugin(String id,
                                             String fileKey)

Updates an installed Plug-in in the Kintone environment.

Parameters:

id - the Plug-in ID.

fileKey - the fileKey representing an uploaded file.

Returns:

the response data. See UpdatePluginResponseBody

updatePlugin

public UpdatePluginResponseBody updatePlugin(UpdatePluginRequest request)

Updates an installed Plug-in in the Kintone environment.

Parameters:

request - the request parameters. See UpdatePluginRequest

Returns:

the response data. See UpdatePluginResponseBody

getApps

public List<App> getApps(String id)

Gets the list of Apps that have the specified Plug-in added.

Parameters:

id - The ID of the plug-in.

Returns:

A list of objects containing the App ID and name.

getApps

public List<App> getApps(String id,
                         Long offset,
                         Long limit)

Gets the list of Apps that have the specified Plug-in added.

Parameters:

id - The ID of the plug-in.

offset - The maximum number of plug-ins to retrieve.

limit - The number of plug-ins to skip from the list of plug-ins.

Returns:

A list of objects containing the App ID and name.

getApps

public GetAppsResponseBody getApps(GetAppsRequest request)

Gets the list of Apps that have the specified Plug-in added.

Parameters:

request - the request parameters. See GetAppsRequest

Returns:

the response data. See GetAppsResponseBody

getRequiredPlugins

public List<Plugin> getRequiredPlugins()

Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.

Returns:

A list of Plug-ins that needs to be installed.

getRequiredPlugins

public List<Plugin> getRequiredPlugins(Long offset,
                                       Long limit)

Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.

Parameters:

offset - The number of plug-ins to skip from the list of required plug-ins.

limit - The maximum number of plug-ins to retrieve.

Returns:

A list of Plug-ins that needs to be installed.

getRequiredPlugins

public GetRequiredPluginsResponseBody getRequiredPlugins(GetRequiredPluginsRequest request)

Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.

Parameters:

request - the request parameters. See GetRequiredPluginsRequest

Returns:

the response data. See GetRequiredPluginsResponseBody