| Package | Description |
|---|---|
| com.groupdocs.cloud.annotation.api | |
| com.groupdocs.cloud.annotation.client | |
| com.groupdocs.cloud.annotation.client.auth |
| Modifier and Type | Method | Description |
|---|---|---|
AnnotationApiLink |
AnnotateApi.annotate(AnnotateRequest request) |
Adds annotations to document and saves output file into cloud storage
|
com.squareup.okhttp.Call |
AnnotateApi.annotateAsync(AnnotateRequest request,
ApiCallback<AnnotationApiLink> callback) |
Adds annotations to document and saves output file into cloud storage (asynchronously)
|
com.squareup.okhttp.Call |
AnnotateApi.annotateCall(AnnotateRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for annotate
|
File |
AnnotateApi.annotateDirect(AnnotateDirectRequest request) |
Adds annotations to document and returns output file
|
com.squareup.okhttp.Call |
AnnotateApi.annotateDirectAsync(AnnotateDirectRequest request,
ApiCallback<File> callback) |
Adds annotations to document and returns output file (asynchronously)
|
com.squareup.okhttp.Call |
AnnotateApi.annotateDirectCall(AnnotateDirectRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for annotateDirect
|
ApiResponse<File> |
AnnotateApi.annotateDirectWithHttpInfo(AnnotateDirectRequest request) |
Adds annotations to document and returns output file
|
ApiResponse<AnnotationApiLink> |
AnnotateApi.annotateWithHttpInfo(AnnotateRequest request) |
Adds annotations to document and saves output file into cloud storage
|
void |
FileApi.copyFile(CopyFileRequest request) |
Copy file
|
com.squareup.okhttp.Call |
FileApi.copyFileAsync(CopyFileRequest request,
ApiCallback<Void> callback) |
Copy file (asynchronously)
|
com.squareup.okhttp.Call |
FileApi.copyFileCall(CopyFileRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for copyFile
|
ApiResponse<Void> |
FileApi.copyFileWithHttpInfo(CopyFileRequest request) |
Copy file
|
void |
FolderApi.copyFolder(CopyFolderRequest request) |
Copy folder
|
com.squareup.okhttp.Call |
FolderApi.copyFolderAsync(CopyFolderRequest request,
ApiCallback<Void> callback) |
Copy folder (asynchronously)
|
com.squareup.okhttp.Call |
FolderApi.copyFolderCall(CopyFolderRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for copyFolder
|
ApiResponse<Void> |
FolderApi.copyFolderWithHttpInfo(CopyFolderRequest request) |
Copy folder
|
void |
FolderApi.createFolder(CreateFolderRequest request) |
Create the folder
|
com.squareup.okhttp.Call |
FolderApi.createFolderAsync(CreateFolderRequest request,
ApiCallback<Void> callback) |
Create the folder (asynchronously)
|
com.squareup.okhttp.Call |
FolderApi.createFolderCall(CreateFolderRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for createFolder
|
ApiResponse<Void> |
FolderApi.createFolderWithHttpInfo(CreateFolderRequest request) |
Create the folder
|
void |
FileApi.deleteFile(DeleteFileRequest request) |
Delete file
|
com.squareup.okhttp.Call |
FileApi.deleteFileAsync(DeleteFileRequest request,
ApiCallback<Void> callback) |
Delete file (asynchronously)
|
com.squareup.okhttp.Call |
FileApi.deleteFileCall(DeleteFileRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for deleteFile
|
ApiResponse<Void> |
FileApi.deleteFileWithHttpInfo(DeleteFileRequest request) |
Delete file
|
void |
FolderApi.deleteFolder(DeleteFolderRequest request) |
Delete folder
|
com.squareup.okhttp.Call |
FolderApi.deleteFolderAsync(DeleteFolderRequest request,
ApiCallback<Void> callback) |
Delete folder (asynchronously)
|
com.squareup.okhttp.Call |
FolderApi.deleteFolderCall(DeleteFolderRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for deleteFolder
|
ApiResponse<Void> |
FolderApi.deleteFolderWithHttpInfo(DeleteFolderRequest request) |
Delete folder
|
void |
PreviewApi.deletePages(DeletePagesRequest request) |
Removes document's pages image representations
|
com.squareup.okhttp.Call |
PreviewApi.deletePagesAsync(DeletePagesRequest request,
ApiCallback<Void> callback) |
Removes document's pages image representations (asynchronously)
|
com.squareup.okhttp.Call |
PreviewApi.deletePagesCall(DeletePagesRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for deletePages
|
ApiResponse<Void> |
PreviewApi.deletePagesWithHttpInfo(DeletePagesRequest request) |
Removes document's pages image representations
|
File |
FileApi.downloadFile(DownloadFileRequest request) |
Download file
|
com.squareup.okhttp.Call |
FileApi.downloadFileAsync(DownloadFileRequest request,
ApiCallback<File> callback) |
Download file (asynchronously)
|
com.squareup.okhttp.Call |
FileApi.downloadFileCall(DownloadFileRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for downloadFile
|
ApiResponse<File> |
FileApi.downloadFileWithHttpInfo(DownloadFileRequest request) |
Download file
|
List<AnnotationInfo> |
AnnotateApi.extract(ExtractRequest request) |
Extracts annotations from document
|
com.squareup.okhttp.Call |
AnnotateApi.extractAsync(ExtractRequest request,
ApiCallback<List<AnnotationInfo>> callback) |
Extracts annotations from document (asynchronously)
|
com.squareup.okhttp.Call |
AnnotateApi.extractCall(ExtractRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for extract
|
ApiResponse<List<AnnotationInfo>> |
AnnotateApi.extractWithHttpInfo(ExtractRequest request) |
Extracts annotations from document
|
ConsumptionResult |
LicenseApi.getConsumptionCredit() |
Get license consumption
|
com.squareup.okhttp.Call |
LicenseApi.getConsumptionCreditAsync(ApiCallback<ConsumptionResult> callback) |
Get license consumption (asynchronously)
|
com.squareup.okhttp.Call |
LicenseApi.getConsumptionCreditCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getConsumptionCredit
|
ApiResponse<ConsumptionResult> |
LicenseApi.getConsumptionCreditWithHttpInfo() |
Get license consumption
|
DiscUsage |
StorageApi.getDiscUsage(GetDiscUsageRequest request) |
Get disc usage
|
com.squareup.okhttp.Call |
StorageApi.getDiscUsageAsync(GetDiscUsageRequest request,
ApiCallback<DiscUsage> callback) |
Get disc usage (asynchronously)
|
com.squareup.okhttp.Call |
StorageApi.getDiscUsageCall(GetDiscUsageRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getDiscUsage
|
ApiResponse<DiscUsage> |
StorageApi.getDiscUsageWithHttpInfo(GetDiscUsageRequest request) |
Get disc usage
|
FilesList |
FolderApi.getFilesList(GetFilesListRequest request) |
Get all files and folders within a folder
|
com.squareup.okhttp.Call |
FolderApi.getFilesListAsync(GetFilesListRequest request,
ApiCallback<FilesList> callback) |
Get all files and folders within a folder (asynchronously)
|
com.squareup.okhttp.Call |
FolderApi.getFilesListCall(GetFilesListRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getFilesList
|
ApiResponse<FilesList> |
FolderApi.getFilesListWithHttpInfo(GetFilesListRequest request) |
Get all files and folders within a folder
|
FileVersions |
StorageApi.getFileVersions(GetFileVersionsRequest request) |
Get file versions
|
com.squareup.okhttp.Call |
StorageApi.getFileVersionsAsync(GetFileVersionsRequest request,
ApiCallback<FileVersions> callback) |
Get file versions (asynchronously)
|
com.squareup.okhttp.Call |
StorageApi.getFileVersionsCall(GetFileVersionsRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getFileVersions
|
ApiResponse<FileVersions> |
StorageApi.getFileVersionsWithHttpInfo(GetFileVersionsRequest request) |
Get file versions
|
DocumentInfo |
InfoApi.getInfo(GetInfoRequest request) |
Retrieves basic document info - path, extension, formats, size etc
|
com.squareup.okhttp.Call |
InfoApi.getInfoAsync(GetInfoRequest request,
ApiCallback<DocumentInfo> callback) |
Retrieves basic document info - path, extension, formats, size etc (asynchronously)
|
com.squareup.okhttp.Call |
InfoApi.getInfoCall(GetInfoRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getInfo
|
ApiResponse<DocumentInfo> |
InfoApi.getInfoWithHttpInfo(GetInfoRequest request) |
Retrieves basic document info - path, extension, formats, size etc
|
PageImages |
PreviewApi.getPages(GetPagesRequest request) |
Generates image representations from documents pages
|
com.squareup.okhttp.Call |
PreviewApi.getPagesAsync(GetPagesRequest request,
ApiCallback<PageImages> callback) |
Generates image representations from documents pages (asynchronously)
|
com.squareup.okhttp.Call |
PreviewApi.getPagesCall(GetPagesRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getPages
|
ApiResponse<PageImages> |
PreviewApi.getPagesWithHttpInfo(GetPagesRequest request) |
Generates image representations from documents pages
|
FormatsResult |
InfoApi.getSupportedFileFormats() |
Retrieves supported file formats list
|
com.squareup.okhttp.Call |
InfoApi.getSupportedFileFormatsAsync(ApiCallback<FormatsResult> callback) |
Retrieves supported file formats list (asynchronously)
|
com.squareup.okhttp.Call |
InfoApi.getSupportedFileFormatsCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for getSupportedFileFormats
|
ApiResponse<FormatsResult> |
InfoApi.getSupportedFileFormatsWithHttpInfo() |
Retrieves supported file formats list
|
void |
FileApi.moveFile(MoveFileRequest request) |
Move file
|
com.squareup.okhttp.Call |
FileApi.moveFileAsync(MoveFileRequest request,
ApiCallback<Void> callback) |
Move file (asynchronously)
|
com.squareup.okhttp.Call |
FileApi.moveFileCall(MoveFileRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for moveFile
|
ApiResponse<Void> |
FileApi.moveFileWithHttpInfo(MoveFileRequest request) |
Move file
|
void |
FolderApi.moveFolder(MoveFolderRequest request) |
Move folder
|
com.squareup.okhttp.Call |
FolderApi.moveFolderAsync(MoveFolderRequest request,
ApiCallback<Void> callback) |
Move folder (asynchronously)
|
com.squareup.okhttp.Call |
FolderApi.moveFolderCall(MoveFolderRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for moveFolder
|
ApiResponse<Void> |
FolderApi.moveFolderWithHttpInfo(MoveFolderRequest request) |
Move folder
|
ObjectExist |
StorageApi.objectExists(ObjectExistsRequest request) |
Check if file or folder exists
|
com.squareup.okhttp.Call |
StorageApi.objectExistsAsync(ObjectExistsRequest request,
ApiCallback<ObjectExist> callback) |
Check if file or folder exists (asynchronously)
|
com.squareup.okhttp.Call |
StorageApi.objectExistsCall(ObjectExistsRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for objectExists
|
ApiResponse<ObjectExist> |
StorageApi.objectExistsWithHttpInfo(ObjectExistsRequest request) |
Check if file or folder exists
|
AnnotationApiLink |
AnnotateApi.removeAnnotations(RemoveAnnotationsRequest request) |
Removes annotations from document
|
com.squareup.okhttp.Call |
AnnotateApi.removeAnnotationsAsync(RemoveAnnotationsRequest request,
ApiCallback<AnnotationApiLink> callback) |
Removes annotations from document (asynchronously)
|
com.squareup.okhttp.Call |
AnnotateApi.removeAnnotationsCall(RemoveAnnotationsRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for removeAnnotations
|
ApiResponse<AnnotationApiLink> |
AnnotateApi.removeAnnotationsWithHttpInfo(RemoveAnnotationsRequest request) |
Removes annotations from document
|
StorageExist |
StorageApi.storageExists(StorageExistsRequest request) |
Check if storage exists
|
com.squareup.okhttp.Call |
StorageApi.storageExistsAsync(StorageExistsRequest request,
ApiCallback<StorageExist> callback) |
Check if storage exists (asynchronously)
|
com.squareup.okhttp.Call |
StorageApi.storageExistsCall(StorageExistsRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for storageExists
|
ApiResponse<StorageExist> |
StorageApi.storageExistsWithHttpInfo(StorageExistsRequest request) |
Check if storage exists
|
FilesUploadResult |
FileApi.uploadFile(UploadFileRequest request) |
Upload file
|
com.squareup.okhttp.Call |
FileApi.uploadFileAsync(UploadFileRequest request,
ApiCallback<FilesUploadResult> callback) |
Upload file (asynchronously)
|
com.squareup.okhttp.Call |
FileApi.uploadFileCall(UploadFileRequest request,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build call for uploadFile
|
ApiResponse<FilesUploadResult> |
FileApi.uploadFileWithHttpInfo(UploadFileRequest request) |
Upload file
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
ApiCallback.onFailure(ApiException e,
int statusCode,
Map<String,List<String>> responseHeaders) |
This is called when the API call fails.
|
| Modifier and Type | Method | Description |
|---|---|---|
com.squareup.okhttp.Call |
ApiClient.buildCall(String path,
String method,
List<Pair> queryParams,
List<Pair> collectionQueryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build HTTP call with the given options.
|
com.squareup.okhttp.Request |
ApiClient.buildRequest(String path,
String method,
List<Pair> queryParams,
List<Pair> collectionQueryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener) |
Build an HTTP request with the given options.
|
<T> T |
ApiClient.deserialize(com.squareup.okhttp.Response response,
Type returnType) |
Deserialize response body to Java object, according to the return type and
the Content-Type response header.
|
File |
ApiClient.downloadFileFromResponse(com.squareup.okhttp.Response response) |
Download file from the given response.
|
<T> ApiResponse<T> |
ApiClient.execute(com.squareup.okhttp.Call call) |
|
<T> ApiResponse<T> |
ApiClient.execute(com.squareup.okhttp.Call call,
Type returnType) |
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
<T> T |
ApiClient.handleResponse(com.squareup.okhttp.Response response,
Type returnType) |
Handle the given response, return the deserialized object when the response is successful.
|
com.squareup.okhttp.RequestBody |
ApiClient.serialize(Object obj,
String contentType) |
Serialize the given Java object into request body according to the object's
class and the request Content-Type.
|
void |
ApiClient.updateParamsForAuth(String[] authNames,
List<Pair> queryParams,
Map<String,String> headerParams) |
Update query and header parameters based on authentication settings.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
Authentication.applyToParams(List<Pair> queryParams,
Map<String,String> headerParams) |
Apply authentication settings to header and query params.
|
void |
OAuth.applyToParams(List<Pair> queryParams,
Map<String,String> headerParams) |
Copyright © 2025. All rights reserved.