com.kintone.client

Class KintoneClient

Object

KintoneClient

All Implemented Interfaces:

AutoCloseable

public class KintoneClient
extends Object
implements AutoCloseable

A KintoneClient is the client for operating Kintone APIs.

To obtain an instance of this class, must use KintoneClientBuilder.

 KintoneClient client = KintoneClientBuilder.create("https://{your Kintone domain}.cybozu.com")
                                            .authByPassword(username, password)
                                            .build();
 

This class provides Kintone APIs via sub-components: RecordClient, AppClient, and so on. For example, if you want to get a record of an App, use the record() method of this class to get the record client.

 Record record = client.record().getRecord(appId, recordId);
 

See each sub-component to find the documents of specific APIs.

Note:

The instance of this class holds an HTTP connection inside. Call close() to releases any resources associated with the connection when the instance is no longer used.

Method Summary

Modifier and Type	Method and Description
AppClient	app() Get the client for app APIs.
BulkRequestsResponseBody	bulkRequests(BulkRequestsRequest request) Runs multiple API requests sequentially to multiple Apps.
void	close()
FileClient	file() Get the client for file APIs.
PluginClient	plugin() Get the client for plugin APIs.
RecordClient	record() Get the client for record APIs.
SchemaClient	schema() Get the client for schema APIs.
SpaceClient	space() Get the client for space APIs.

Methods inherited from class Object

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

Method Detail

app

public AppClient app()

Get the client for app APIs.

Returns:

the app client

record

public RecordClient record()

Get the client for record APIs.

Returns:

the record client

space

public SpaceClient space()

Get the client for space APIs.

Returns:

the space client

file

public FileClient file()

Get the client for file APIs.

Returns:

the file client

schema

public SchemaClient schema()

Get the client for schema APIs.

Returns:

the schema client

plugin

public PluginClient plugin()

Get the client for plugin APIs.

Returns:

the plugin client

bulkRequests

public BulkRequestsResponseBody bulkRequests(BulkRequestsRequest request)

Runs multiple API requests sequentially to multiple Apps.

Parameters:

request - the request parameters. See BulkRequestsRequest

Returns:

the response data. See BulkRequestsResponseBody

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException