Package com.groupdocs.cloud.annotation.api

Class AnnotateApi

java.lang.Object

com.groupdocs.cloud.annotation.api.AnnotateApi

public class AnnotateApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AnnotationApiLink	annotate(AnnotateRequest request)	Adds annotations to document and saves output file into cloud storage
com.squareup.okhttp.Call	annotateAsync(AnnotateRequest request, ApiCallback<AnnotationApiLink> callback)	Adds annotations to document and saves output file into cloud storage (asynchronously)
com.squareup.okhttp.Call	annotateCall(AnnotateRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for annotate
File	annotateDirect(AnnotateDirectRequest request)	Adds annotations to document and returns output file
com.squareup.okhttp.Call	annotateDirectAsync(AnnotateDirectRequest request, ApiCallback<File> callback)	Adds annotations to document and returns output file (asynchronously)
com.squareup.okhttp.Call	annotateDirectCall(AnnotateDirectRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for annotateDirect
ApiResponse<File>	annotateDirectWithHttpInfo(AnnotateDirectRequest request)	Adds annotations to document and returns output file
ApiResponse<AnnotationApiLink>	annotateWithHttpInfo(AnnotateRequest request)	Adds annotations to document and saves output file into cloud storage
List<AnnotationInfo>	extract(ExtractRequest request)	Extracts annotations from document
com.squareup.okhttp.Call	extractAsync(ExtractRequest request, ApiCallback<List<AnnotationInfo>> callback)	Extracts annotations from document (asynchronously)
com.squareup.okhttp.Call	extractCall(ExtractRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for extract
ApiResponse<List<AnnotationInfo>>	extractWithHttpInfo(ExtractRequest request)	Extracts annotations from document
ApiClient	getApiClient()	Gets ApiClient
AnnotationApiLink	removeAnnotations(RemoveAnnotationsRequest request)	Removes annotations from document
com.squareup.okhttp.Call	removeAnnotationsAsync(RemoveAnnotationsRequest request, ApiCallback<AnnotationApiLink> callback)	Removes annotations from document (asynchronously)
com.squareup.okhttp.Call	removeAnnotationsCall(RemoveAnnotationsRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for removeAnnotations
ApiResponse<AnnotationApiLink>	removeAnnotationsWithHttpInfo(RemoveAnnotationsRequest request)	Removes annotations from document
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

AnnotateApi

public AnnotateApi(String appSid,
                   String appKey)

Initializes new instance of AnnotateApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

AnnotateApi

public AnnotateApi(Configuration configuration)

Initializes new instance of AnnotateApi

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

annotateCall

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

Build call for annotate

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

annotate

public AnnotationApiLink annotate(AnnotateRequest request)
                           throws ApiException

Adds annotations to document and saves output file into cloud storage

Parameters:

request - The request model

Returns:

AnnotationApiLink

Throws:

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

annotateWithHttpInfo

public ApiResponse<AnnotationApiLink> annotateWithHttpInfo(AnnotateRequest request)
                                                    throws ApiException

Adds annotations to document and saves output file into cloud storage

Parameters:

request - The request model

Returns:

ApiResponse<AnnotationApiLink>

Throws:

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

annotateAsync

public com.squareup.okhttp.Call annotateAsync(AnnotateRequest request,
                                              ApiCallback<AnnotationApiLink> callback)
                                       throws ApiException

Adds annotations to document and saves output file into cloud storage (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

annotateDirectCall

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

Build call for annotateDirect

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

annotateDirect

public File annotateDirect(AnnotateDirectRequest request)
                    throws ApiException

Adds annotations to document and returns output file

Parameters:

request - The request model

Returns:

File

Throws:

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

annotateDirectWithHttpInfo

public ApiResponse<File> annotateDirectWithHttpInfo(AnnotateDirectRequest request)
                                             throws ApiException

Adds annotations to document and returns output file

Parameters:

request - The request model

Returns:

ApiResponse<File>

Throws:

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

annotateDirectAsync

public com.squareup.okhttp.Call annotateDirectAsync(AnnotateDirectRequest request,
                                                    ApiCallback<File> callback)
                                             throws ApiException

Adds annotations to document and returns output file (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

extractCall

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

Build call for extract

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

extract

public List<AnnotationInfo> extract(ExtractRequest request)
                             throws ApiException

Extracts annotations from document

Parameters:

request - The request model

Returns:

List<AnnotationInfo>

Throws:

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

extractWithHttpInfo

public ApiResponse<List<AnnotationInfo>> extractWithHttpInfo(ExtractRequest request)
                                                      throws ApiException

Extracts annotations from document

Parameters:

request - The request model

Returns:

ApiResponse<List<AnnotationInfo>>

Throws:

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

extractAsync

public com.squareup.okhttp.Call extractAsync(ExtractRequest request,
                                             ApiCallback<List<AnnotationInfo>> callback)
                                      throws ApiException

Extracts annotations from document (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

removeAnnotationsCall

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

Build call for removeAnnotations

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

removeAnnotations

public AnnotationApiLink removeAnnotations(RemoveAnnotationsRequest request)
                                    throws ApiException

Removes annotations from document

Parameters:

request - The request model

Returns:

AnnotationApiLink

Throws:

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

removeAnnotationsWithHttpInfo

public ApiResponse<AnnotationApiLink> removeAnnotationsWithHttpInfo(RemoveAnnotationsRequest request)
                                                             throws ApiException

Removes annotations from document

Parameters:

request - The request model

Returns:

ApiResponse<AnnotationApiLink>

Throws:

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

removeAnnotationsAsync

public com.squareup.okhttp.Call removeAnnotationsAsync(RemoveAnnotationsRequest request,
                                                       ApiCallback<AnnotationApiLink> callback)
                                                throws ApiException

Removes annotations from document (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