cn.vika.client.api

类 VikaApiClient

java.lang.Object

cn.vika.client.api.VikaApiClient

public class VikaApiClient
extends Object

This class is provides a simplified interface to a Vikadata API server, and divides the API up into a separate API class for each concern.

作者:

Shawn Deng

create date:

2021-02-05 11:10:33

构造器概要

构造器

构造器和说明
VikaApiClient(ApiCredential credential)
VikaApiClient(ApiHttpClient.ApiVersion apiVersion, String hostUrl, ApiCredential credential)
VikaApiClient(String hostUrl, ApiCredential credential)

方法概要

限定符和类型	方法和说明
ApiHttpClient.ApiVersion	getApiVersion() Return the API version that this instance is using.
AttachmentApi	getAttachmentApi()
int	getDefaultPerPage() Get the default number per page for calls that return multiple items.
RecordApi	getRecordApi()
void	setDefaultPerPage(int defaultPerPage) Set the default number per page for calls that return multiple items.
void	setReadTimeout(Integer readTimeout) Sets the per request read timeout.
void	setRequestTimeout(Integer connectTimeout) Sets the per request connect timeout.
VikaApiClient	withReadTimeout(Integer readTimeout) Build method that sets the per request read timeout.
VikaApiClient	withRequestTimeout(Integer connectTimeout) Build method that sets the per request connect timeout.

从类继承的方法 java.lang.Object

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

构造器详细资料

VikaApiClient

public VikaApiClient(ApiCredential credential)

VikaApiClient

public VikaApiClient(String hostUrl,
                     ApiCredential credential)

VikaApiClient

public VikaApiClient(ApiHttpClient.ApiVersion apiVersion,
                     String hostUrl,
                     ApiCredential credential)

方法详细资料

getApiVersion

public ApiHttpClient.ApiVersion getApiVersion()

Return the API version that this instance is using.

返回:

the API version that this instance is using

getDefaultPerPage

public int getDefaultPerPage()

Get the default number per page for calls that return multiple items.

返回:

the default number per page for calls that return multiple item

setDefaultPerPage

public void setDefaultPerPage(int defaultPerPage)

Set the default number per page for calls that return multiple items.

参数:

defaultPerPage - the new default number per page for calls that return multiple item

setRequestTimeout

public void setRequestTimeout(Integer connectTimeout)

Sets the per request connect timeout.

参数:

connectTimeout - the per request connect timeout in milliseconds, can be null to use default

withRequestTimeout

public VikaApiClient withRequestTimeout(Integer connectTimeout)

Build method that sets the per request connect timeout.

参数:

connectTimeout - the per request connect timeout in milliseconds, can be null to use default

返回:

VikaApiClient instance

setReadTimeout

public void setReadTimeout(Integer readTimeout)

Sets the per request read timeout.

参数:

readTimeout - the per request read timeout in milliseconds, can be null to use default

withReadTimeout

public VikaApiClient withReadTimeout(Integer readTimeout)

Build method that sets the per request read timeout.

参数:

readTimeout - the per request read timeout in milliseconds, can be null to use default

返回:

VikaApiClient instance

getRecordApi

public RecordApi getRecordApi()

getAttachmentApi

public AttachmentApi getAttachmentApi()