Package com.groupdocs.cloud.viewer.api

Class ViewApi

java.lang.Object

com.groupdocs.cloud.viewer.api.ViewApi

public class ViewApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
File	convertAndDownload(ConvertAndDownloadRequest request)	Converts input document file to format specified
com.squareup.okhttp.Call	convertAndDownloadAsync(ConvertAndDownloadRequest request, ApiCallback<File> callback)	Converts input document file to format specified (asynchronously)
com.squareup.okhttp.Call	convertAndDownloadCall(ConvertAndDownloadRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for convertAndDownload
ApiResponse<File>	convertAndDownloadWithHttpInfo(ConvertAndDownloadRequest request)	Converts input document file to format specified
ViewResult	createView(CreateViewRequest request)	Render document pages
com.squareup.okhttp.Call	createViewAsync(CreateViewRequest request, ApiCallback<ViewResult> callback)	Render document pages (asynchronously)
com.squareup.okhttp.Call	createViewCall(CreateViewRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for createView
ApiResponse<ViewResult>	createViewWithHttpInfo(CreateViewRequest request)	Render document pages
void	deleteView(DeleteViewRequest request)	Delete rendered pages
com.squareup.okhttp.Call	deleteViewAsync(DeleteViewRequest request, ApiCallback<Void> callback)	Delete rendered pages (asynchronously)
com.squareup.okhttp.Call	deleteViewCall(DeleteViewRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteView
ApiResponse<Void>	deleteViewWithHttpInfo(DeleteViewRequest request)	Delete rendered pages
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

ViewApi

public ViewApi(String appSid,
               String appKey)

Initializes new instance of ViewApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

ViewApi

public ViewApi(Configuration configuration)

Initializes new instance of ViewApi

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

convertAndDownloadCall

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

Build call for convertAndDownload

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

convertAndDownload

public File convertAndDownload(ConvertAndDownloadRequest 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

convertAndDownloadWithHttpInfo

public ApiResponse<File> convertAndDownloadWithHttpInfo(ConvertAndDownloadRequest 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

convertAndDownloadAsync

public com.squareup.okhttp.Call convertAndDownloadAsync(ConvertAndDownloadRequest 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

createViewCall

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

Build call for createView

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

createView

public ViewResult createView(CreateViewRequest request)
                      throws ApiException

Render document pages

Parameters:

request - The request model

Returns:

ViewResult

Throws:

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

createViewWithHttpInfo

public ApiResponse<ViewResult> createViewWithHttpInfo(CreateViewRequest request)
                                               throws ApiException

Render document pages

Parameters:

request - The request model

Returns:

ApiResponse<ViewResult>

Throws:

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

createViewAsync

public com.squareup.okhttp.Call createViewAsync(CreateViewRequest request,
                                                ApiCallback<ViewResult> callback)
                                         throws ApiException

Render document 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

deleteViewCall

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

Build call for deleteView

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

deleteView

public void deleteView(DeleteViewRequest request)
                throws ApiException

Delete rendered pages

Parameters:

request - The request model

Throws:

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

deleteViewWithHttpInfo

public ApiResponse<Void> deleteViewWithHttpInfo(DeleteViewRequest request)
                                         throws ApiException

Delete rendered pages

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

deleteViewAsync

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

Delete rendered 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