public class ImagingApi extends Object
Modifier and Type | Field and Description |
---|---|
Configuration |
Configuration
The configuration
|
static String |
Version
Current SDK version
|
Constructor and Description |
---|
ImagingApi(String appKey,
String appSid)
Initializes a new instance of the ImagingApi class.
|
ImagingApi(String appKey,
String appSid,
String baseUrl)
Initializes a new instance of the ImagingApi class.
|
ImagingApi(String appKey,
String appSid,
String baseUrl,
String apiVersion)
Initializes a new instance of the ImagingApi class.
|
ImagingApi(String appKey,
String appSid,
String baseUrl,
String apiVersion,
Boolean debug)
Initializes a new instance of the ImagingApi class.
|
Modifier and Type | Method and Description |
---|---|
void |
copyFile(CopyFileRequest request)
Copy file
|
void |
copyFolder(CopyFolderRequest request)
Copy folder
|
void |
createFolder(CreateFolderRequest request)
Create the folder
|
void |
deleteFile(DeleteFileRequest request)
Delete file
|
void |
deleteFolder(DeleteFolderRequest request)
Delete folder
|
void |
deleteSearchContext(DeleteSearchContextRequest request)
Deletes the search context.
|
void |
deleteSearchContextImage(DeleteSearchContextImageRequest request)
Delete image and images features from search context
|
void |
deleteSearchContextImageFeatures(DeleteSearchContextImageFeaturesRequest request)
Deletes image features from search context.
|
byte[] |
downloadFile(DownloadFileRequest request)
Download file
|
DiscUsage |
getDiscUsage(GetDiscUsageRequest request)
Get disc usage
|
FilesList |
getFilesList(GetFilesListRequest request)
Get all files and folders within a folder
|
FileVersions |
getFileVersions(GetFileVersionsRequest request)
Get file versions
|
byte[] |
getImageBmp(GetImageBmpRequest request)
Update parameters of existing BMP image.
|
byte[] |
getImageCrop(GetImageCropRequest request)
Crop an existing image.
|
byte[] |
getImageEmf(GetImageEmfRequest request)
Process existing EMF imaging using given parameters.
|
byte[] |
getImageFrame(GetImageFrameRequest request)
Get separate frame from existing TIFF image.
|
ImagingResponse |
getImageFrameProperties(GetImageFramePropertiesRequest request)
Get separate frame properties of existing TIFF image.
|
byte[] |
getImageGif(GetImageGifRequest request)
Update parameters of existing GIF image.
|
byte[] |
getImageJpeg2000(GetImageJpeg2000Request request)
Update parameters of existing JPEG2000 image.
|
byte[] |
getImageJpg(GetImageJpgRequest request)
Update parameters of existing JPEG image.
|
ImagingResponse |
getImageProperties(GetImagePropertiesRequest request)
Get properties of an image.
|
byte[] |
getImagePsd(GetImagePsdRequest request)
Update parameters of existing PSD image.
|
byte[] |
getImageResize(GetImageResizeRequest request)
Resize an existing image.
|
byte[] |
getImageRotateFlip(GetImageRotateFlipRequest request)
Rotate and/or flip an existing image.
|
byte[] |
getImageSaveAs(GetImageSaveAsRequest request)
Export existing image to another format.
|
byte[] |
getImageTiff(GetImageTiffRequest request)
Update parameters of existing TIFF image.
|
byte[] |
getImageUpdate(GetImageUpdateRequest request)
Perform scaling, cropping and flipping of an existing image in a single request.
|
byte[] |
getImageWebP(GetImageWebPRequest request)
Update parameters of existing WEBP image.
|
byte[] |
getImageWmf(GetImageWmfRequest request)
Process existing WMF image using given parameters.
|
ImageFeatures |
getSearchContextExtractImageFeatures(GetSearchContextExtractImageFeaturesRequest request)
Extract features from image without adding to search context.
|
ImageDuplicatesSet |
getSearchContextFindDuplicates(GetSearchContextFindDuplicatesRequest request)
Find images duplicates.
|
SearchResultsSet |
getSearchContextFindSimilar(GetSearchContextFindSimilarRequest request)
Find similar images.
|
byte[] |
getSearchContextImage(GetSearchContextImageRequest request)
Get image from search context
|
ImageFeatures |
getSearchContextImageFeatures(GetSearchContextImageFeaturesRequest request)
Gets image features from search context.
|
SearchContextStatus |
getSearchContextStatus(GetSearchContextStatusRequest request)
Gets the search context status.
|
byte[] |
getTiffToFax(GetTiffToFaxRequest request)
Update parameters of existing TIFF image accordingly to fax parameters.
|
void |
moveFile(MoveFileRequest request)
Move file
|
void |
moveFolder(MoveFolderRequest request)
Move folder
|
ObjectExist |
objectExists(ObjectExistsRequest request)
Check if file or folder exists
|
SearchContextStatus |
postCreateSearchContext(PostCreateSearchContextRequest request)
Create new search context.
|
byte[] |
postImageBmp(PostImageBmpRequest request)
Update parameters of BMP image.
|
byte[] |
postImageCrop(PostImageCropRequest request)
Crop an image.
|
byte[] |
postImageEmf(PostImageEmfRequest request)
Process existing EMF imaging using given parameters.
|
byte[] |
postImageFrame(PostImageFrameRequest request)
Get separate frame from existing TIFF image.
|
ImagingResponse |
postImageFrameProperties(PostImageFramePropertiesRequest request)
Get separate frame properties of existing TIFF image.
|
byte[] |
postImageGif(PostImageGifRequest request)
Update parameters of GIF image.
|
byte[] |
postImageJpeg2000(PostImageJpeg2000Request request)
Update parameters of JPEG2000 image.
|
byte[] |
postImageJpg(PostImageJpgRequest request)
Update parameters of JPEG image.
|
ImagingResponse |
postImageProperties(PostImagePropertiesRequest request)
Get properties of an image.
|
byte[] |
postImagePsd(PostImagePsdRequest request)
Update parameters of PSD image.
|
byte[] |
postImageResize(PostImageResizeRequest request)
Resize an image.
|
byte[] |
postImageRotateFlip(PostImageRotateFlipRequest request)
Rotate and/or flip an image.
|
byte[] |
postImageSaveAs(PostImageSaveAsRequest request)
Export existing image to another format.
|
byte[] |
postImageTiff(PostImageTiffRequest request)
Update parameters of TIFF image.
|
byte[] |
postImageUpdate(PostImageUpdateRequest request)
Perform scaling, cropping and flipping of an image in a single request.
|
byte[] |
postImageWebP(PostImageWebPRequest request)
Update parameters of WEBP image.
|
byte[] |
postImageWmf(PostImageWmfRequest request)
Process existing WMF image using given parameters.
|
void |
postSearchContextAddImage(PostSearchContextAddImageRequest request)
Add image and images features to search context.
|
void |
postSearchContextAddTag(PostSearchContextAddTagRequest request)
Add tag and reference image to search context.
|
SearchResultsSet |
postSearchContextCompareImages(PostSearchContextCompareImagesRequest request)
Compare two images.
|
void |
postSearchContextExtractImageFeatures(PostSearchContextExtractImageFeaturesRequest request)
Extract images features and add them to search context.
|
SearchResultsSet |
postSearchContextFindByTags(PostSearchContextFindByTagsRequest request)
Find images by tags.
|
void |
postTiffAppend(PostTiffAppendRequest request)
Appends existing TIFF image to another existing TIFF image (i.e.
|
void |
putSearchContextImage(PutSearchContextImageRequest request)
Update image and images features in search context.
|
void |
putSearchContextImageFeatures(PutSearchContextImageFeaturesRequest request)
Update images features in search context.
|
StorageExist |
storageExists(StorageExistsRequest request)
Check if storage exists
|
FilesUploadResult |
uploadFile(UploadFileRequest request)
Upload file
|
public static final String Version
public Configuration Configuration
public ImagingApi(String appKey, String appSid)
appKey
- The app key.appSid
- The app SID.public ImagingApi(String appKey, String appSid, String baseUrl)
appKey
- The app key.appSid
- The app SID.baseUrl
- The base URL.public ImagingApi(String appKey, String appSid, String baseUrl, String apiVersion) throws Exception
appKey
- The app key.appSid
- The app SID.baseUrl
- The base URL.apiVersion
- API version.Exception
public ImagingApi(String appKey, String appSid, String baseUrl, String apiVersion, Boolean debug) throws Exception
appKey
- The app key.appSid
- The app SID.baseUrl
- The base URL.apiVersion
- API version.debug
- If debug mode is enabled.Exception
public void copyFile(CopyFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void copyFolder(CopyFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void createFolder(CreateFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteFile(DeleteFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteFolder(DeleteFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteSearchContext(DeleteSearchContextRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteSearchContextImage(DeleteSearchContextImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void deleteSearchContextImageFeatures(DeleteSearchContextImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] downloadFile(DownloadFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public DiscUsage getDiscUsage(GetDiscUsageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public FileVersions getFileVersions(GetFileVersionsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public FilesList getFilesList(GetFilesListRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageBmp(GetImageBmpRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageCrop(GetImageCropRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageEmf(GetImageEmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageFrame(GetImageFrameRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse getImageFrameProperties(GetImageFramePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageGif(GetImageGifRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageJpeg2000(GetImageJpeg2000Request request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageJpg(GetImageJpgRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse getImageProperties(GetImagePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImagePsd(GetImagePsdRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageResize(GetImageResizeRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageRotateFlip(GetImageRotateFlipRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageSaveAs(GetImageSaveAsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageTiff(GetImageTiffRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageUpdate(GetImageUpdateRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageWebP(GetImageWebPRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getImageWmf(GetImageWmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImageFeatures getSearchContextExtractImageFeatures(GetSearchContextExtractImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImageDuplicatesSet getSearchContextFindDuplicates(GetSearchContextFindDuplicatesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchResultsSet getSearchContextFindSimilar(GetSearchContextFindSimilarRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getSearchContextImage(GetSearchContextImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImageFeatures getSearchContextImageFeatures(GetSearchContextImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchContextStatus getSearchContextStatus(GetSearchContextStatusRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] getTiffToFax(GetTiffToFaxRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void moveFile(MoveFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void moveFolder(MoveFolderRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ObjectExist objectExists(ObjectExistsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchContextStatus postCreateSearchContext(PostCreateSearchContextRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageBmp(PostImageBmpRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageCrop(PostImageCropRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageEmf(PostImageEmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageFrame(PostImageFrameRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse postImageFrameProperties(PostImageFramePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageGif(PostImageGifRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageJpeg2000(PostImageJpeg2000Request request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageJpg(PostImageJpgRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public ImagingResponse postImageProperties(PostImagePropertiesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImagePsd(PostImagePsdRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageResize(PostImageResizeRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageRotateFlip(PostImageRotateFlipRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageSaveAs(PostImageSaveAsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageTiff(PostImageTiffRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageUpdate(PostImageUpdateRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageWebP(PostImageWebPRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public byte[] postImageWmf(PostImageWmfRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void postSearchContextAddImage(PostSearchContextAddImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void postSearchContextAddTag(PostSearchContextAddTagRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchResultsSet postSearchContextCompareImages(PostSearchContextCompareImagesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void postSearchContextExtractImageFeatures(PostSearchContextExtractImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public SearchResultsSet postSearchContextFindByTags(PostSearchContextFindByTagsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void postTiffAppend(PostTiffAppendRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void putSearchContextImage(PutSearchContextImageRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public void putSearchContextImageFeatures(PutSearchContextImageFeaturesRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public StorageExist storageExists(StorageExistsRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
public FilesUploadResult uploadFile(UploadFileRequest request) throws Exception
request
- Holds parameters for this request invocation.Exception
Copyright © 2019 Aspose Pty Ltd. All rights reserved.