public class PreviewApi extends Object
| Constructor | Description |
|---|---|
PreviewApi(Configuration configuration) |
Initializes new instance of PreviewApi
|
PreviewApi(String appSid,
String appKey) |
Initializes new instance of PreviewApi
|
| Modifier and Type | Method | Description |
|---|---|---|
ApiClient |
getApiClient() |
Gets ApiClient
|
List<Link> |
preview(PreviewRequest request) |
Creates a preview images of document pages and returns an array of links to saved result
|
com.squareup.okhttp.Call |
previewAsync(PreviewRequest request,
ApiCallback<List<Link>> callback) |
Creates a preview images of document pages and returns an array of links to saved result (asynchronously)
|
com.squareup.okhttp.Call |
previewCall(PreviewRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for preview
|
ApiResponse<List<Link>> |
previewWithHttpInfo(PreviewRequest request) |
Creates a preview images of document pages and returns an array of links to saved result
|
void |
setApiClient(ApiClient apiClient) |
Sets ApiClient
|
public PreviewApi(String appSid, String appKey)
appSid - Application identifier (App SID)appKey - Application private key (App Key)public PreviewApi(Configuration configuration)
configuration - Configuration The configurationpublic ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
apiClient - The Api clientpublic com.squareup.okhttp.Call previewCall(PreviewRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
request - The request modelprogressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic List<Link> preview(PreviewRequest request) throws ApiException
request - The request modelApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<Link>> previewWithHttpInfo(PreviewRequest request) throws ApiException
request - The request modelApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call previewAsync(PreviewRequest request, ApiCallback<List<Link>> callback) throws ApiException
request - The request modelcallback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2025. All rights reserved.