Package com.groupdocs.cloud.annotation.api

Class PreviewApi

java.lang.Object

com.groupdocs.cloud.annotation.api.PreviewApi

public class PreviewApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	deletePages(DeletePagesRequest request)	Removes document's pages image representations
com.squareup.okhttp.Call	deletePagesAsync(DeletePagesRequest request, ApiCallback<Void> callback)	Removes document's pages image representations (asynchronously)
com.squareup.okhttp.Call	deletePagesCall(DeletePagesRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deletePages
ApiResponse<Void>	deletePagesWithHttpInfo(DeletePagesRequest request)	Removes document's pages image representations
ApiClient	getApiClient()	Gets ApiClient
PageImages	getPages(GetPagesRequest request)	Generates image representations from documents pages
com.squareup.okhttp.Call	getPagesAsync(GetPagesRequest request, ApiCallback<PageImages> callback)	Generates image representations from documents pages (asynchronously)
com.squareup.okhttp.Call	getPagesCall(GetPagesRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getPages
ApiResponse<PageImages>	getPagesWithHttpInfo(GetPagesRequest request)	Generates image representations from documents pages
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

PreviewApi

public PreviewApi(String appSid,
                  String appKey)

Initializes new instance of PreviewApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

PreviewApi

public PreviewApi(Configuration configuration)

Initializes new instance of PreviewApi

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

deletePagesCall

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

Build call for deletePages

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

deletePages

public void deletePages(DeletePagesRequest request)
                 throws ApiException

Removes document's pages image representations

Parameters:

request - The request model

Throws:

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

deletePagesWithHttpInfo

public ApiResponse<Void> deletePagesWithHttpInfo(DeletePagesRequest request)
                                          throws ApiException

Removes document's pages image representations

Parameters:

request - The request model

Returns:

ApiResponse<Void>

Throws:

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

deletePagesAsync

public com.squareup.okhttp.Call deletePagesAsync(DeletePagesRequest request,
                                                 ApiCallback<Void> callback)
                                          throws ApiException

Removes document's pages image representations (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

getPagesCall

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

Build call for getPages

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

getPages

public PageImages getPages(GetPagesRequest request)
                    throws ApiException

Generates image representations from documents pages

Parameters:

request - The request model

Returns:

PageImages

Throws:

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

getPagesWithHttpInfo

public ApiResponse<PageImages> getPagesWithHttpInfo(GetPagesRequest request)
                                             throws ApiException

Generates image representations from documents pages

Parameters:

request - The request model

Returns:

ApiResponse<PageImages>

Throws:

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

getPagesAsync

public com.squareup.okhttp.Call getPagesAsync(GetPagesRequest request,
                                              ApiCallback<PageImages> callback)
                                       throws ApiException

Generates image representations from documents pages (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