Package com.groupdocs.cloud.parser.api

Class ParseApi

java.lang.Object

com.groupdocs.cloud.parser.api.ParseApi

public class ParseApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BarcodesResult	barcodes(BarcodesRequest request)	Extract barcodes from document.
com.squareup.okhttp.Call	barcodesAsync(BarcodesRequest request, ApiCallback<BarcodesResult> callback)	Extract barcodes from document.
com.squareup.okhttp.Call	barcodesCall(BarcodesRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for barcodes
ApiResponse<BarcodesResult>	barcodesWithHttpInfo(BarcodesRequest request)	Extract barcodes from document.
ApiClient	getApiClient()	Gets ApiClient
ImagesResult	images(ImagesRequest request)	Extract images from document.
com.squareup.okhttp.Call	imagesAsync(ImagesRequest request, ApiCallback<ImagesResult> callback)	Extract images from document.
com.squareup.okhttp.Call	imagesCall(ImagesRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for images
ApiResponse<ImagesResult>	imagesWithHttpInfo(ImagesRequest request)	Extract images from document.
ParseResult	parse(ParseRequest request)	Extract document data by a predefined template.
com.squareup.okhttp.Call	parseAsync(ParseRequest request, ApiCallback<ParseResult> callback)	Extract document data by a predefined template.
com.squareup.okhttp.Call	parseCall(ParseRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for parse
ApiResponse<ParseResult>	parseWithHttpInfo(ParseRequest request)	Extract document data by a predefined template.
void	setApiClient(ApiClient apiClient)	Sets ApiClient
TextResult	text(TextRequest request)	Extract text from document.
com.squareup.okhttp.Call	textAsync(TextRequest request, ApiCallback<TextResult> callback)	Extract text from document.
com.squareup.okhttp.Call	textCall(TextRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for text
ApiResponse<TextResult>	textWithHttpInfo(TextRequest request)	Extract text from document.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParseApi

public ParseApi(String appSid,
                String appKey)

Initializes new instance of ParseApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

ParseApi

public ParseApi(Configuration configuration)

Initializes new instance of ParseApi

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

barcodesCall

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

Build call for barcodes

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

barcodes

public BarcodesResult barcodes(BarcodesRequest request)
                        throws ApiException

Extract barcodes from document.

Parameters:

request - The request model

Returns:

BarcodesResult

Throws:

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

barcodesWithHttpInfo

public ApiResponse<BarcodesResult> barcodesWithHttpInfo(BarcodesRequest request)
                                                 throws ApiException

Extract barcodes from document.

Parameters:

request - The request model

Returns:

ApiResponse<BarcodesResult>

Throws:

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

barcodesAsync

public com.squareup.okhttp.Call barcodesAsync(BarcodesRequest request,
                                              ApiCallback<BarcodesResult> callback)
                                       throws ApiException

Extract barcodes 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

imagesCall

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

Build call for images

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

images

public ImagesResult images(ImagesRequest request)
                    throws ApiException

Extract images from document.

Parameters:

request - The request model

Returns:

ImagesResult

Throws:

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

imagesWithHttpInfo

public ApiResponse<ImagesResult> imagesWithHttpInfo(ImagesRequest request)
                                             throws ApiException

Extract images from document.

Parameters:

request - The request model

Returns:

ApiResponse<ImagesResult>

Throws:

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

imagesAsync

public com.squareup.okhttp.Call imagesAsync(ImagesRequest request,
                                            ApiCallback<ImagesResult> callback)
                                     throws ApiException

Extract images 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

parseCall

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

Build call for parse

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

parse

public ParseResult parse(ParseRequest request)
                  throws ApiException

Extract document data by a predefined template.

Parameters:

request - The request model

Returns:

ParseResult

Throws:

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

parseWithHttpInfo

public ApiResponse<ParseResult> parseWithHttpInfo(ParseRequest request)
                                           throws ApiException

Extract document data by a predefined template.

Parameters:

request - The request model

Returns:

ApiResponse<ParseResult>

Throws:

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

parseAsync

public com.squareup.okhttp.Call parseAsync(ParseRequest request,
                                           ApiCallback<ParseResult> callback)
                                    throws ApiException

Extract document data by a predefined template. (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

textCall

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

Build call for text

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

text

public TextResult text(TextRequest request)
                throws ApiException

Extract text from document.

Parameters:

request - The request model

Returns:

TextResult

Throws:

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

textWithHttpInfo

public ApiResponse<TextResult> textWithHttpInfo(TextRequest request)
                                         throws ApiException

Extract text from document.

Parameters:

request - The request model

Returns:

ApiResponse<TextResult>

Throws:

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

textAsync

public com.squareup.okhttp.Call textAsync(TextRequest request,
                                          ApiCallback<TextResult> callback)
                                   throws ApiException

Extract text 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