Package com.groupdocs.cloud.comparison.api

Class CompareApi

java.lang.Object

com.groupdocs.cloud.comparison.api.CompareApi

public class CompareApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CompareApi(Configuration configuration)	Initializes new instance of CompareApi
CompareApi(String appSid, String appKey)	Initializes new instance of CompareApi

Method Summary

Modifier and Type	Method	Description
Link	comparisons(ComparisonsRequest request)	Compares source and target documents and returns a link to saved result
com.squareup.okhttp.Call	comparisonsAsync(ComparisonsRequest request, ApiCallback<Link> callback)	Compares source and target documents and returns a link to saved result (asynchronously)
com.squareup.okhttp.Call	comparisonsCall(ComparisonsRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for comparisons
ApiResponse<Link>	comparisonsWithHttpInfo(ComparisonsRequest request)	Compares source and target documents and returns a link to saved result
ApiClient	getApiClient()	Gets ApiClient
List<ChangeInfo>	postChanges(PostChangesRequest request)	Retrieves a list of changes between source and target documents
com.squareup.okhttp.Call	postChangesAsync(PostChangesRequest request, ApiCallback<List<ChangeInfo>> callback)	Retrieves a list of changes between source and target documents (asynchronously)
com.squareup.okhttp.Call	postChangesCall(PostChangesRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for postChanges
ApiResponse<List<ChangeInfo>>	postChangesWithHttpInfo(PostChangesRequest request)	Retrieves a list of changes between source and target documents
Link	putChangesDocument(PutChangesDocumentRequest request)	Accepts or rejects changes to the resultant document and returns a link to saved result
com.squareup.okhttp.Call	putChangesDocumentAsync(PutChangesDocumentRequest request, ApiCallback<Link> callback)	Accepts or rejects changes to the resultant document and returns a link to saved result (asynchronously)
com.squareup.okhttp.Call	putChangesDocumentCall(PutChangesDocumentRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for putChangesDocument
ApiResponse<Link>	putChangesDocumentWithHttpInfo(PutChangesDocumentRequest request)	Accepts or rejects changes to the resultant document and returns a link to saved result
void	setApiClient(ApiClient apiClient)	Sets ApiClient

Methods inherited from class java.lang.Object

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

Constructor Detail

CompareApi

public CompareApi(String appSid,
                  String appKey)

Initializes new instance of CompareApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

CompareApi

public CompareApi(Configuration configuration)

Initializes new instance of CompareApi

Parameters:

configuration - Configuration The configuration

Method Detail

getApiClient

public ApiClient getApiClient()

Gets ApiClient

Returns:

ApiClient The Api client

setApiClient

public void setApiClient(ApiClient apiClient)

Sets ApiClient

Parameters:

apiClient - The Api client

comparisonsCall

public com.squareup.okhttp.Call comparisonsCall(ComparisonsRequest request,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for comparisons

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

comparisons

public Link comparisons(ComparisonsRequest request)
                 throws ApiException

Compares source and target documents and returns a link to saved result

Parameters:

request - The request model

Returns:

Link

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

comparisonsWithHttpInfo

public ApiResponse<Link> comparisonsWithHttpInfo(ComparisonsRequest request)
                                          throws ApiException

Compares source and target documents and returns a link to saved result

Parameters:

request - The request model

Returns:

ApiResponse<Link>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

comparisonsAsync

public com.squareup.okhttp.Call comparisonsAsync(ComparisonsRequest request,
                                                 ApiCallback<Link> callback)
                                          throws ApiException

Compares source and target documents and returns a link to saved result (asynchronously)

Parameters:

request - The request model

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

postChangesCall

public com.squareup.okhttp.Call postChangesCall(PostChangesRequest request,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for postChanges

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postChanges

public List<ChangeInfo> postChanges(PostChangesRequest request)
                             throws ApiException

Retrieves a list of changes between source and target documents

Parameters:

request - The request model

Returns:

List<ChangeInfo>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postChangesWithHttpInfo

public ApiResponse<List<ChangeInfo>> postChangesWithHttpInfo(PostChangesRequest request)
                                                      throws ApiException

Retrieves a list of changes between source and target documents

Parameters:

request - The request model

Returns:

ApiResponse<List<ChangeInfo>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

postChangesAsync

public com.squareup.okhttp.Call postChangesAsync(PostChangesRequest request,
                                                 ApiCallback<List<ChangeInfo>> callback)
                                          throws ApiException

Retrieves a list of changes between source and target documents (asynchronously)

Parameters:

request - The request model

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

putChangesDocumentCall

public com.squareup.okhttp.Call putChangesDocumentCall(PutChangesDocumentRequest request,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for putChangesDocument

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

putChangesDocument

public Link putChangesDocument(PutChangesDocumentRequest request)
                        throws ApiException

Accepts or rejects changes to the resultant document and returns a link to saved result

Parameters:

request - The request model

Returns:

Link

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

putChangesDocumentWithHttpInfo

public ApiResponse<Link> putChangesDocumentWithHttpInfo(PutChangesDocumentRequest request)
                                                 throws ApiException

Accepts or rejects changes to the resultant document and returns a link to saved result

Parameters:

request - The request model

Returns:

ApiResponse<Link>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

putChangesDocumentAsync

public com.squareup.okhttp.Call putChangesDocumentAsync(PutChangesDocumentRequest request,
                                                        ApiCallback<Link> callback)
                                                 throws ApiException

Accepts or rejects changes to the resultant document and returns a link to saved result (asynchronously)

Parameters:

request - The request model

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object