Package com.groupdocs.cloud.signature.api

Class PreviewApi

java.lang.Object

com.groupdocs.cloud.signature.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
ApiClient	getApiClient()	Gets ApiClient
PreviewResult	previewDocument(PreviewDocumentRequest request)	Creates document preview images
com.squareup.okhttp.Call	previewDocumentAsync(PreviewDocumentRequest request, ApiCallback<PreviewResult> callback)	Creates document preview images (asynchronously)
com.squareup.okhttp.Call	previewDocumentCall(PreviewDocumentRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for previewDocument
ApiResponse<PreviewResult>	previewDocumentWithHttpInfo(PreviewDocumentRequest request)	Creates document preview images
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

previewDocumentCall

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

Build call for previewDocument

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

previewDocument

public PreviewResult previewDocument(PreviewDocumentRequest request)
                              throws ApiException

Creates document preview images

Parameters:

request - The request model

Returns:

PreviewResult

Throws:

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

previewDocumentWithHttpInfo

public ApiResponse<PreviewResult> previewDocumentWithHttpInfo(PreviewDocumentRequest request)
                                                       throws ApiException

Creates document preview images

Parameters:

request - The request model

Returns:

ApiResponse<PreviewResult>

Throws:

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

previewDocumentAsync

public com.squareup.okhttp.Call previewDocumentAsync(PreviewDocumentRequest request,
                                                     ApiCallback<PreviewResult> callback)
                                              throws ApiException

Creates document preview images (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