Package com.groupdocs.cloud.merger.api

Class DocumentApi

java.lang.Object

com.groupdocs.cloud.merger.api.DocumentApi

public class DocumentApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DocumentResult	callImport(CallImportRequest request)	Import attachments into pdf document
com.squareup.okhttp.Call	callImportAsync(CallImportRequest request, ApiCallback<DocumentResult> callback)	Import attachments into pdf document (asynchronously)
com.squareup.okhttp.Call	callImportCall(CallImportRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for callImport
ApiResponse<DocumentResult>	callImportWithHttpInfo(CallImportRequest request)	Import attachments into pdf document
ApiClient	getApiClient()	Gets ApiClient
DocumentResult	join(JoinRequest request)	Join multiple documents into one document
com.squareup.okhttp.Call	joinAsync(JoinRequest request, ApiCallback<DocumentResult> callback)	Join multiple documents into one document (asynchronously)
com.squareup.okhttp.Call	joinCall(JoinRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for join
ApiResponse<DocumentResult>	joinWithHttpInfo(JoinRequest request)	Join multiple documents into one document
DocumentResult	mix(MixRequest request)	Join selected pages from multiple documents into one document
com.squareup.okhttp.Call	mixAsync(MixRequest request, ApiCallback<DocumentResult> callback)	Join selected pages from multiple documents into one document (asynchronously)
com.squareup.okhttp.Call	mixCall(MixRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for mix
ApiResponse<DocumentResult>	mixWithHttpInfo(MixRequest request)	Join selected pages from multiple documents into one document
MultiDocumentResult	preview(PreviewRequest request)	Generate document pages preview
com.squareup.okhttp.Call	previewAsync(PreviewRequest request, ApiCallback<MultiDocumentResult> callback)	Generate document pages preview (asynchronously)
com.squareup.okhttp.Call	previewCall(PreviewRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for preview
ApiResponse<MultiDocumentResult>	previewWithHttpInfo(PreviewRequest request)	Generate document pages preview
void	setApiClient(ApiClient apiClient)	Sets ApiClient
MultiDocumentResult	split(SplitRequest request)	Split single document to multiple documents
com.squareup.okhttp.Call	splitAsync(SplitRequest request, ApiCallback<MultiDocumentResult> callback)	Split single document to multiple documents (asynchronously)
com.squareup.okhttp.Call	splitCall(SplitRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for split
ApiResponse<MultiDocumentResult>	splitWithHttpInfo(SplitRequest request)	Split single document to multiple documents

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentApi

public DocumentApi(String appSid,
                   String appKey)

Initializes new instance of DocumentApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

DocumentApi

public DocumentApi(Configuration configuration)

Initializes new instance of DocumentApi

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

callImportCall

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

Build call for callImport

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

callImport

public DocumentResult callImport(CallImportRequest request)
                          throws ApiException

Import attachments into pdf document

Parameters:

request - The request model

Returns:

DocumentResult

Throws:

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

callImportWithHttpInfo

public ApiResponse<DocumentResult> callImportWithHttpInfo(CallImportRequest request)
                                                   throws ApiException

Import attachments into pdf document

Parameters:

request - The request model

Returns:

ApiResponse<DocumentResult>

Throws:

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

callImportAsync

public com.squareup.okhttp.Call callImportAsync(CallImportRequest request,
                                                ApiCallback<DocumentResult> callback)
                                         throws ApiException

Import attachments into pdf 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

joinCall

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

Build call for join

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

join

public DocumentResult join(JoinRequest request)
                    throws ApiException

Join multiple documents into one document

Parameters:

request - The request model

Returns:

DocumentResult

Throws:

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

joinWithHttpInfo

public ApiResponse<DocumentResult> joinWithHttpInfo(JoinRequest request)
                                             throws ApiException

Join multiple documents into one document

Parameters:

request - The request model

Returns:

ApiResponse<DocumentResult>

Throws:

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

joinAsync

public com.squareup.okhttp.Call joinAsync(JoinRequest request,
                                          ApiCallback<DocumentResult> callback)
                                   throws ApiException

Join multiple documents into one 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

mixCall

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

Build call for mix

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

mix

public DocumentResult mix(MixRequest request)
                   throws ApiException

Join selected pages from multiple documents into one document

Parameters:

request - The request model

Returns:

DocumentResult

Throws:

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

mixWithHttpInfo

public ApiResponse<DocumentResult> mixWithHttpInfo(MixRequest request)
                                            throws ApiException

Join selected pages from multiple documents into one document

Parameters:

request - The request model

Returns:

ApiResponse<DocumentResult>

Throws:

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

mixAsync

public com.squareup.okhttp.Call mixAsync(MixRequest request,
                                         ApiCallback<DocumentResult> callback)
                                  throws ApiException

Join selected pages from multiple documents into one 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

previewCall

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

Build call for preview

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

preview

public MultiDocumentResult preview(PreviewRequest request)
                            throws ApiException

Generate document pages preview

Parameters:

request - The request model

Returns:

MultiDocumentResult

Throws:

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

previewWithHttpInfo

public ApiResponse<MultiDocumentResult> previewWithHttpInfo(PreviewRequest request)
                                                     throws ApiException

Generate document pages preview

Parameters:

request - The request model

Returns:

ApiResponse<MultiDocumentResult>

Throws:

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

previewAsync

public com.squareup.okhttp.Call previewAsync(PreviewRequest request,
                                             ApiCallback<MultiDocumentResult> callback)
                                      throws ApiException

Generate document pages preview (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

splitCall

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

Build call for split

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

split

public MultiDocumentResult split(SplitRequest request)
                          throws ApiException

Split single document to multiple documents

Parameters:

request - The request model

Returns:

MultiDocumentResult

Throws:

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

splitWithHttpInfo

public ApiResponse<MultiDocumentResult> splitWithHttpInfo(SplitRequest request)
                                                   throws ApiException

Split single document to multiple documents

Parameters:

request - The request model

Returns:

ApiResponse<MultiDocumentResult>

Throws:

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

splitAsync

public com.squareup.okhttp.Call splitAsync(SplitRequest request,
                                           ApiCallback<MultiDocumentResult> callback)
                                    throws ApiException

Split single document to multiple documents (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