Package com.groupdocs.cloud.conversion.api

Class AsyncApi

java.lang.Object

com.groupdocs.cloud.conversion.api.AsyncApi

public class AsyncApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Gets ApiClient
File	getOperationResult(GetOperationResultRequest request)	Get async operation result
com.squareup.okhttp.Call	getOperationResultAsync(GetOperationResultRequest request, ApiCallback<File> callback)	Get async operation result (asynchronously)
com.squareup.okhttp.Call	getOperationResultCall(GetOperationResultRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getOperationResult
ApiResponse<File>	getOperationResultWithHttpInfo(GetOperationResultRequest request)	Get async operation result
OperationResult	getOperationStatus(GetOperationStatusRequest request)	Get async operation status
com.squareup.okhttp.Call	getOperationStatusAsync(GetOperationStatusRequest request, ApiCallback<OperationResult> callback)	Get async operation status (asynchronously)
com.squareup.okhttp.Call	getOperationStatusCall(GetOperationStatusRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getOperationStatus
ApiResponse<OperationResult>	getOperationStatusWithHttpInfo(GetOperationStatusRequest request)	Get async operation status
void	setApiClient(ApiClient apiClient)	Sets ApiClient
String	startConvert(StartConvertRequest request)	Starts async conversion specified input document, from request body, to format specified
String	startConvertAndSave(StartConvertAndSaveRequest request)	Starts async conversion specified input document to format specified in the convertSettings with specified options
com.squareup.okhttp.Call	startConvertAndSaveAsync(StartConvertAndSaveRequest request, ApiCallback<String> callback)	Starts async conversion specified input document to format specified in the convertSettings with specified options (asynchronously)
com.squareup.okhttp.Call	startConvertAndSaveCall(StartConvertAndSaveRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for startConvertAndSave
ApiResponse<String>	startConvertAndSaveWithHttpInfo(StartConvertAndSaveRequest request)	Starts async conversion specified input document to format specified in the convertSettings with specified options
com.squareup.okhttp.Call	startConvertAsync(StartConvertRequest request, ApiCallback<String> callback)	Starts async conversion specified input document, from request body, to format specified (asynchronously)
com.squareup.okhttp.Call	startConvertCall(StartConvertRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for startConvert
ApiResponse<String>	startConvertWithHttpInfo(StartConvertRequest request)	Starts async conversion specified input document, from request body, to format specified

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncApi

public AsyncApi(String appSid,
                String appKey)

Initializes new instance of AsyncApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

AsyncApi

public AsyncApi(Configuration configuration)

Initializes new instance of AsyncApi

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

getOperationResultCall

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

Build call for getOperationResult

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

getOperationResult

public File getOperationResult(GetOperationResultRequest request)
                        throws ApiException

Get async operation result

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

getOperationResultWithHttpInfo

public ApiResponse<File> getOperationResultWithHttpInfo(GetOperationResultRequest request)
                                                 throws ApiException

Get async operation result

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

getOperationResultAsync

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

Get async operation 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

getOperationStatusCall

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

Build call for getOperationStatus

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

getOperationStatus

public OperationResult getOperationStatus(GetOperationStatusRequest request)
                                   throws ApiException

Get async operation status

Parameters:

request - The request model

Returns:

OperationResult

Throws:

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

getOperationStatusWithHttpInfo

public ApiResponse<OperationResult> getOperationStatusWithHttpInfo(GetOperationStatusRequest request)
                                                            throws ApiException

Get async operation status

Parameters:

request - The request model

Returns:

ApiResponse<OperationResult>

Throws:

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

getOperationStatusAsync

public com.squareup.okhttp.Call getOperationStatusAsync(GetOperationStatusRequest request,
                                                        ApiCallback<OperationResult> callback)
                                                 throws ApiException

Get async operation status (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

startConvertCall

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

Build call for startConvert

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

startConvert

public String startConvert(StartConvertRequest request)
                    throws ApiException

Starts async conversion specified input document, from request body, to format specified

Parameters:

request - The request model

Returns:

String

Throws:

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

startConvertWithHttpInfo

public ApiResponse<String> startConvertWithHttpInfo(StartConvertRequest request)
                                             throws ApiException

Starts async conversion specified input document, from request body, to format specified

Parameters:

request - The request model

Returns:

ApiResponse<String>

Throws:

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

startConvertAsync

public com.squareup.okhttp.Call startConvertAsync(StartConvertRequest request,
                                                  ApiCallback<String> callback)
                                           throws ApiException

Starts async conversion specified input document, from request body, to format specified (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

startConvertAndSaveCall

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

Build call for startConvertAndSave

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

startConvertAndSave

public String startConvertAndSave(StartConvertAndSaveRequest request)
                           throws ApiException

Starts async conversion specified input document to format specified in the convertSettings with specified options

Parameters:

request - The request model

Returns:

String

Throws:

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

startConvertAndSaveWithHttpInfo

public ApiResponse<String> startConvertAndSaveWithHttpInfo(StartConvertAndSaveRequest request)
                                                    throws ApiException

Starts async conversion specified input document to format specified in the convertSettings with specified options

Parameters:

request - The request model

Returns:

ApiResponse<String>

Throws:

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

startConvertAndSaveAsync

public com.squareup.okhttp.Call startConvertAndSaveAsync(StartConvertAndSaveRequest request,
                                                         ApiCallback<String> callback)
                                                  throws ApiException

Starts async conversion specified input document to format specified in the convertSettings with specified options (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