Package com.groupdocs.cloud.conversion.api

Class ConvertApi

java.lang.Object

com.groupdocs.cloud.conversion.api.ConvertApi

public class ConvertApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<StoredConvertedResult>	convertDocument(ConvertDocumentRequest request)	Converts specified input document to format specified in the convertSettings with specified options
com.squareup.okhttp.Call	convertDocumentAsync(ConvertDocumentRequest request, ApiCallback<Void> callback)	Converts specified input document to format specified in the convertSettings with specified options (asynchronously)
com.squareup.okhttp.Call	convertDocumentCall(ConvertDocumentRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for convertDocument
File	convertDocumentDirect(ConvertDocumentDirectRequest request)	Converts input document file to format specified
com.squareup.okhttp.Call	convertDocumentDirectAsync(ConvertDocumentDirectRequest request, ApiCallback<File> callback)	Converts input document file to format specified (asynchronously)
com.squareup.okhttp.Call	convertDocumentDirectCall(ConvertDocumentDirectRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for convertDocumentDirect
ApiResponse<File>	convertDocumentDirectWithHttpInfo(ConvertDocumentDirectRequest request)	Converts input document file to format specified
File	convertDocumentDownload(ConvertDocumentRequest request)	Converts specified input document to format specified in the convertSettings with specified options and download
com.squareup.okhttp.Call	convertDocumentDownloadAsync(ConvertDocumentRequest request, ApiCallback<Void> callback)	Converts specified input document to format specified in the convertSettings with specified options (asynchronously) and download
com.squareup.okhttp.Call	convertDocumentDownloadCall(ConvertDocumentRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for convertDocumentDownload
ApiResponse<File>	convertDocumentDownloadWithHttpInfo(ConvertDocumentRequest request)	Converts specified input document to format specified in the convertSettings with specified options and download
ApiResponse<List<StoredConvertedResult>>	convertDocumentWithHttpInfo(ConvertDocumentRequest request)	Converts specified input document to format specified in the convertSettings with specified options
ApiClient	getApiClient()	Gets ApiClient
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

ConvertApi

public ConvertApi(String appSid,
                  String appKey)

Initializes new instance of ConvertApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

ConvertApi

public ConvertApi(Configuration configuration)

Initializes new instance of ConvertApi

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

convertDocumentCall

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

Build call for convertDocument

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

convertDocument

public List<StoredConvertedResult> convertDocument(ConvertDocumentRequest request)
                                            throws ApiException

Converts specified input document to format specified in the convertSettings with specified options

Parameters:

request - The request model

Returns:

List<StoredConvertedResult>

Throws:

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

convertDocumentWithHttpInfo

public ApiResponse<List<StoredConvertedResult>> convertDocumentWithHttpInfo(ConvertDocumentRequest request)
                                                                     throws ApiException

Converts specified input document to format specified in the convertSettings with specified options

Parameters:

request - The request model

Returns:

ApiResponse<List<StoredConvertedResult>>

Throws:

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

convertDocumentAsync

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

Converts 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

convertDocumentDownloadCall

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

Build call for convertDocumentDownload

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

convertDocumentDownload

public File convertDocumentDownload(ConvertDocumentRequest request)
                             throws ApiException

Converts specified input document to format specified in the convertSettings with specified options and download

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

convertDocumentDownloadWithHttpInfo

public ApiResponse<File> convertDocumentDownloadWithHttpInfo(ConvertDocumentRequest request)
                                                      throws ApiException

Converts specified input document to format specified in the convertSettings with specified options and download

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

convertDocumentDownloadAsync

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

Converts specified input document to format specified in the convertSettings with specified options (asynchronously) and download

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

convertDocumentDirectCall

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

Build call for convertDocumentDirect

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

convertDocumentDirect

public File convertDocumentDirect(ConvertDocumentDirectRequest request)
                           throws ApiException

Converts input document file to format specified

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

convertDocumentDirectWithHttpInfo

public ApiResponse<File> convertDocumentDirectWithHttpInfo(ConvertDocumentDirectRequest request)
                                                    throws ApiException

Converts input document file to format specified

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

convertDocumentDirectAsync

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

Converts input document file 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