public class DocumentApi extends Object
| Constructor | Description |
|---|---|
DocumentApi(Configuration configuration) |
Initializes new instance of DocumentApi
|
DocumentApi(String appSid,
String appKey) |
Initializes new instance of DocumentApi
|
| 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
|
public DocumentApi(String appSid, String appKey)
appSid - Application identifier (App SID)appKey - Application private key (App Key)public DocumentApi(Configuration configuration)
configuration - Configuration The configurationpublic ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
apiClient - The Api clientpublic com.squareup.okhttp.Call callImportCall(CallImportRequest 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 DocumentResult callImport(CallImportRequest request) throws ApiException
request - The request modelApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<DocumentResult> callImportWithHttpInfo(CallImportRequest 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 callImportAsync(CallImportRequest request, ApiCallback<DocumentResult> 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 objectpublic com.squareup.okhttp.Call joinCall(JoinRequest 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 DocumentResult join(JoinRequest request) throws ApiException
request - The request modelApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<DocumentResult> joinWithHttpInfo(JoinRequest 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 joinAsync(JoinRequest request, ApiCallback<DocumentResult> 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 objectpublic com.squareup.okhttp.Call mixCall(MixRequest 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 DocumentResult mix(MixRequest request) throws ApiException
request - The request modelApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<DocumentResult> mixWithHttpInfo(MixRequest 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 mixAsync(MixRequest request, ApiCallback<DocumentResult> 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 objectpublic 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 MultiDocumentResult 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<MultiDocumentResult> 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<MultiDocumentResult> 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 objectpublic com.squareup.okhttp.Call splitCall(SplitRequest 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 MultiDocumentResult split(SplitRequest request) throws ApiException
request - The request modelApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<MultiDocumentResult> splitWithHttpInfo(SplitRequest 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 splitAsync(SplitRequest request, ApiCallback<MultiDocumentResult> 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.