Package Exports
- asposepdfcloud
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (asposepdfcloud) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Aspose.PDF Cloud
Aspose.PDF Cloud is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of Pdf documents in the cloud.
Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process documents in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights. This repository contains new generation SDKs for Aspose.PDF Cloud and examples.
These SDKs are now fully supported. If you have any questions, see any bugs or have enhancement request, feel free to reach out to us at Free Support Forums.
Installation
NPM
From the command line:
$ npm install asposepdfcloud --saveUsage
APIs of this SDK can be called as follows:
const { PdfApi } = require("asposepdfcloud");
let pdfApi = new PdfApi(AppSid, AppKey);
let pageNumber = 1;
let pdfDocName = "example.pdf";
let remoteFolder = "folderName";
pdfApi.getPageAnnotations(pdfDocName, pageNumber, null, remoteFolder)
.then((result) => {
console.log(result.response);
console.log(result.body);
});
Unit Tests
Aspose PDF SDK includes a suite of unit tests within the "test" subdirectory. These Unit Tests also serves as examples of how to use the Aspose PDF SDK.
Licensing
All Aspose.PDF Cloud SDKs are licensed under MIT License.
Resources
Documentation for API Endpoints
All URIs are relative to https://api.aspose.cloud/v2.0/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PdfApi | deleteAnnotation | DELETE /pdf/{name}/annotations/{annotationId} | Delete document annotation by ID |
| PdfApi | deleteDocumentAnnotations | DELETE /pdf/{name}/annotations | Delete all annotations from the document |
| PdfApi | deleteDocumentLinkAnnotations | DELETE /pdf/{name}/links | Delete all link annotations from the document |
| PdfApi | deleteDocumentStamps | DELETE /pdf/{name}/stamps | Delete all stamps from the document |
| PdfApi | deleteDocumentTables | DELETE /pdf/{name}/tables | Delete all tables from the document |
| PdfApi | deleteField | DELETE /pdf/{name}/fields/{fieldName} | Delete document field by name. |
| PdfApi | deleteFile | DELETE /storage/file | Remove a specific file |
| PdfApi | deleteFolder | DELETE /storage/folder | Remove a specific folder |
| PdfApi | deleteImage | DELETE /pdf/{name}/images/{imageId} | Delete image from document page. |
| PdfApi | deleteLinkAnnotation | DELETE /pdf/{name}/links/{linkId} | Delete document page link annotation by ID |
| PdfApi | deletePage | DELETE /pdf/{name}/pages/{pageNumber} | Delete document page by its number. |
| PdfApi | deletePageAnnotations | DELETE /pdf/{name}/pages/{pageNumber}/annotations | Delete all annotations from the page |
| PdfApi | deletePageLinkAnnotations | DELETE /pdf/{name}/pages/{pageNumber}/links | Delete all link annotations from the page |
| PdfApi | deletePageStamps | DELETE /pdf/{name}/pages/{pageNumber}/stamps | Delete all stamps from the page |
| PdfApi | deletePageTables | DELETE /pdf/{name}/pages/{pageNumber}/tables | Delete all tables from the page |
| PdfApi | deleteProperties | DELETE /pdf/{name}/documentproperties | Delete custom document properties. |
| PdfApi | deleteProperty | DELETE /pdf/{name}/documentproperties/{propertyName} | Delete document property. |
| PdfApi | deleteStamp | DELETE /pdf/{name}/stamps/{stampId} | Delete document stamp by ID |
| PdfApi | deleteTable | DELETE /pdf/{name}/tables/{tableId} | Delete document table by ID |
| PdfApi | getCaretAnnotation | GET /pdf/{name}/annotations/caret/{annotationId} | Read document page caret annotation by ID. |
| PdfApi | getCircleAnnotation | GET /pdf/{name}/annotations/circle/{annotationId} | Read document page circle annotation by ID. |
| PdfApi | getDiscUsage | GET /storage/disc | Check the disk usage of the current account |
| PdfApi | getDocument | GET /pdf/{name} | Read common document info. |
| PdfApi | getDocumentAnnotations | GET /pdf/{name}/annotations | Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. |
| PdfApi | getDocumentAttachmentByIndex | GET /pdf/{name}/attachments/{attachmentIndex} | Read document attachment info by its index. |
| PdfApi | getDocumentAttachments | GET /pdf/{name}/attachments | Read document attachments info. |
| PdfApi | getDocumentBookmarks | GET /pdf/{name}/bookmarks | Read document bookmark/bookmarks (including children). |
| PdfApi | getDocumentCaretAnnotations | GET /pdf/{name}/annotations/caret | Read document caret annotations. |
| PdfApi | getDocumentCircleAnnotations | GET /pdf/{name}/annotations/circle | Read document circle annotations. |
| PdfApi | getDocumentFileAttachmentAnnotations | GET /pdf/{name}/annotations/fileattachment | Read document FileAttachment annotations. |
| PdfApi | getDocumentFreeTextAnnotations | GET /pdf/{name}/annotations/freetext | Read document free text annotations. |
| PdfApi | getDocumentHighlightAnnotations | GET /pdf/{name}/annotations/highlight | Read document highlight annotations. |
| PdfApi | getDocumentInkAnnotations | GET /pdf/{name}/annotations/ink | Read document ink annotations. |
| PdfApi | getDocumentLineAnnotations | GET /pdf/{name}/annotations/line | Read document line annotations. |
| PdfApi | getDocumentMovieAnnotations | GET /pdf/{name}/annotations/movie | Read document movie annotations. |
| PdfApi | getDocumentPolygonAnnotations | GET /pdf/{name}/annotations/polygon | Read document polygon annotations. |
| PdfApi | getDocumentPolyLineAnnotations | GET /pdf/{name}/annotations/polyline | Read document polyline annotations. |
| PdfApi | getDocumentPopupAnnotations | GET /pdf/{name}/annotations/popup | Read document popup annotations. |
| PdfApi | getDocumentPopupAnnotationsByParent | GET /pdf/{name}/annotations/{annotationId}/popup | Read document popup annotations by parent id. |
| PdfApi | getDocumentProperties | GET /pdf/{name}/documentproperties | Read document properties. |
| PdfApi | getDocumentProperty | GET /pdf/{name}/documentproperties/{propertyName} | Read document property by name. |
| PdfApi | getDocumentRedactionAnnotations | GET /pdf/{name}/annotations/redaction | Read document redaction annotations. |
| PdfApi | getDocumentScreenAnnotations | GET /pdf/{name}/annotations/screen | Read document screen annotations. |
| PdfApi | getDocumentSoundAnnotations | GET /pdf/{name}/annotations/sound | Read document sound annotations. |
| PdfApi | getDocumentSquareAnnotations | GET /pdf/{name}/annotations/square | Read document square annotations. |
| PdfApi | getDocumentSquigglyAnnotations | GET /pdf/{name}/annotations/squiggly | Read document squiggly annotations. |
| PdfApi | getDocumentStampAnnotations | GET /pdf/{name}/annotations/stamp | Read document stamp annotations. |
| PdfApi | getDocumentStamps | GET /pdf/{name}/stamps | Read document stamps. |
| PdfApi | getDocumentStrikeOutAnnotations | GET /pdf/{name}/annotations/strikeout | Read document StrikeOut annotations. |
| PdfApi | getDocumentTables | GET /pdf/{name}/tables | Read document tables. |
| PdfApi | getDocumentTextAnnotations | GET /pdf/{name}/annotations/text | Read document text annotations. |
| PdfApi | getDocumentUnderlineAnnotations | GET /pdf/{name}/annotations/underline | Read document underline annotations. |
| PdfApi | getDownload | GET /storage/file | Download a specific file |
| PdfApi | getDownloadDocumentAttachmentByIndex | GET /pdf/{name}/attachments/{attachmentIndex}/download | Download document attachment content by its index. |
| PdfApi | getEpubInStorageToPdf | GET /pdf/create/epub | Convert EPUB file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getField | GET /pdf/{name}/fields/{fieldName} | Get document field by name. |
| PdfApi | getFields | GET /pdf/{name}/fields | Get document fields. |
| PdfApi | getFileAttachmentAnnotation | GET /pdf/{name}/annotations/fileattachment/{annotationId} | Read document page FileAttachment annotation by ID. |
| PdfApi | getFileAttachmentAnnotationData | GET /pdf/{name}/annotations/fileattachment/{annotationId}/data | Read document page FileAttachment annotation by ID. |
| PdfApi | getFreeTextAnnotation | GET /pdf/{name}/annotations/freetext/{annotationId} | Read document page free text annotation by ID. |
| PdfApi | getHighlightAnnotation | GET /pdf/{name}/annotations/highlight/{annotationId} | Read document page highlight annotation by ID. |
| PdfApi | getHtmlInStorageToPdf | GET /pdf/create/html | Convert HTML file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getImage | GET /pdf/{name}/images/{imageId} | Read document image by ID. |
| PdfApi | getImageExtractAsGif | GET /pdf/{name}/images/{imageId}/extract/gif | Extract document image in GIF format |
| PdfApi | getImageExtractAsJpeg | GET /pdf/{name}/images/{imageId}/extract/jpeg | Extract document image in JPEG format |
| PdfApi | getImageExtractAsPng | GET /pdf/{name}/images/{imageId}/extract/png | Extract document image in PNG format |
| PdfApi | getImageExtractAsTiff | GET /pdf/{name}/images/{imageId}/extract/tiff | Extract document image in TIFF format |
| PdfApi | getImages | GET /pdf/{name}/pages/{pageNumber}/images | Read document images. |
| PdfApi | getInkAnnotation | GET /pdf/{name}/annotations/ink/{annotationId} | Read document page ink annotation by ID. |
| PdfApi | getIsExist | GET /storage/exist | Check if a specific file or folder exists |
| PdfApi | getIsStorageExist | GET /storage/{name}/exist | Check if storage exists |
| PdfApi | getLaTeXInStorageToPdf | GET /pdf/create/latex | Convert LaTeX file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getLineAnnotation | GET /pdf/{name}/annotations/line/{annotationId} | Read document page line annotation by ID. |
| PdfApi | getLinkAnnotation | GET /pdf/{name}/links/{linkId} | Read document link annotation by ID. |
| PdfApi | getListFiles | GET /storage/folder | Get the file listing of a specific folder |
| PdfApi | getListFileVersions | GET /storage/version | Get the file's versions list |
| PdfApi | getMhtInStorageToPdf | GET /pdf/create/mht | Convert MHT file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getMovieAnnotation | GET /pdf/{name}/annotations/movie/{annotationId} | Read document page movie annotation by ID. |
| PdfApi | getPage | GET /pdf/{name}/pages/{pageNumber} | Read document page info. |
| PdfApi | getPageAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations | Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases. |
| PdfApi | getPageCaretAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/caret | Read document page caret annotations. |
| PdfApi | getPageCircleAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/circle | Read document page circle annotations. |
| PdfApi | getPageConvertToBmp | GET /pdf/{name}/pages/{pageNumber}/convert/bmp | Convert document page to Bmp image and return resulting file in response. |
| PdfApi | getPageConvertToEmf | GET /pdf/{name}/pages/{pageNumber}/convert/emf | Convert document page to Emf image and return resulting file in response. |
| PdfApi | getPageConvertToGif | GET /pdf/{name}/pages/{pageNumber}/convert/gif | Convert document page to Gif image and return resulting file in response. |
| PdfApi | getPageConvertToJpeg | GET /pdf/{name}/pages/{pageNumber}/convert/jpeg | Convert document page to Jpeg image and return resulting file in response. |
| PdfApi | getPageConvertToPng | GET /pdf/{name}/pages/{pageNumber}/convert/png | Convert document page to Png image and return resulting file in response. |
| PdfApi | getPageConvertToTiff | GET /pdf/{name}/pages/{pageNumber}/convert/tiff | Convert document page to Tiff image and return resulting file in response. |
| PdfApi | getPageFileAttachmentAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/fileattachment | Read document page FileAttachment annotations. |
| PdfApi | getPageFreeTextAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/freetext | Read document page free text annotations. |
| PdfApi | getPageHighlightAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/highlight | Read document page highlight annotations. |
| PdfApi | getPageInkAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/ink | Read document page ink annotations. |
| PdfApi | getPageLineAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/line | Read document page line annotations. |
| PdfApi | getPageLinkAnnotation | GET /pdf/{name}/pages/{pageNumber}/links/{linkId} | Read document page link annotation by ID. |
| PdfApi | getPageLinkAnnotations | GET /pdf/{name}/pages/{pageNumber}/links | Read document page link annotations. |
| PdfApi | getPageMovieAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/movie | Read document page movie annotations. |
| PdfApi | getPagePolygonAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/polygon | Read document page polygon annotations. |
| PdfApi | getPagePolyLineAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/polyline | Read document page polyline annotations. |
| PdfApi | getPagePopupAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/popup | Read document page popup annotations. |
| PdfApi | getPageRedactionAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/redaction | Read document page redaction annotations. |
| PdfApi | getPages | GET /pdf/{name}/pages | Read document pages info. |
| PdfApi | getPageScreenAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/screen | Read document page screen annotations. |
| PdfApi | getPageSoundAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/sound | Read document page sound annotations. |
| PdfApi | getPageSquareAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/square | Read document page square annotations. |
| PdfApi | getPageSquigglyAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/squiggly | Read document page squiggly annotations. |
| PdfApi | getPageStampAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/stamp | Read document page stamp annotations. |
| PdfApi | getPageStamps | GET /pdf/{name}/pages/{pageNumber}/stamps | Read page document stamps. |
| PdfApi | getPageStrikeOutAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/strikeout | Read document page StrikeOut annotations. |
| PdfApi | getPageTables | GET /pdf/{name}/pages/{pageNumber}/tables | Read document page tables. |
| PdfApi | getPageText | GET /pdf/{name}/pages/{pageNumber}/text | Read page text items. |
| PdfApi | getPageTextAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/text | Read document page text annotations. |
| PdfApi | getPageUnderlineAnnotations | GET /pdf/{name}/pages/{pageNumber}/annotations/underline | Read document page underline annotations. |
| PdfApi | getPclInStorageToPdf | GET /pdf/create/pcl | Convert PCL file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getPdfInStorageToDoc | GET /pdf/{name}/convert/doc | Converts PDF document (located on storage) to DOC format and returns resulting file in response content |
| PdfApi | getPdfInStorageToEpub | GET /pdf/{name}/convert/epub | Converts PDF document (located on storage) to EPUB format and returns resulting file in response content |
| PdfApi | getPdfInStorageToHtml | GET /pdf/{name}/convert/html | Converts PDF document (located on storage) to Html format and returns resulting file in response content |
| PdfApi | getPdfInStorageToLaTeX | GET /pdf/{name}/convert/latex | Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content |
| PdfApi | getPdfInStorageToMobiXml | GET /pdf/{name}/convert/mobixml | Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content |
| PdfApi | getPdfInStorageToPdfA | GET /pdf/{name}/convert/pdfa | Converts PDF document (located on storage) to PdfA format and returns resulting file in response content |
| PdfApi | getPdfInStorageToPptx | GET /pdf/{name}/convert/pptx | Converts PDF document (located on storage) to PPTX format and returns resulting file in response content |
| PdfApi | getPdfInStorageToSvg | GET /pdf/{name}/convert/svg | Converts PDF document (located on storage) to SVG format and returns resulting file in response content |
| PdfApi | getPdfInStorageToTiff | GET /pdf/{name}/convert/tiff | Converts PDF document (located on storage) to TIFF format and returns resulting file in response content |
| PdfApi | getPdfInStorageToXls | GET /pdf/{name}/convert/xls | Converts PDF document (located on storage) to XLS format and returns resulting file in response content |
| PdfApi | getPdfInStorageToXml | GET /pdf/{name}/convert/xml | Converts PDF document (located on storage) to XML format and returns resulting file in response content |
| PdfApi | getPdfInStorageToXps | GET /pdf/{name}/convert/xps | Converts PDF document (located on storage) to XPS format and returns resulting file in response content |
| PdfApi | getPolygonAnnotation | GET /pdf/{name}/annotations/polygon/{annotationId} | Read document page polygon annotation by ID. |
| PdfApi | getPolyLineAnnotation | GET /pdf/{name}/annotations/polyline/{annotationId} | Read document page polyline annotation by ID. |
| PdfApi | getPopupAnnotation | GET /pdf/{name}/annotations/popup/{annotationId} | Read document page popup annotation by ID. |
| PdfApi | getPsInStorageToPdf | GET /pdf/create/ps | Convert PS file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getRedactionAnnotation | GET /pdf/{name}/annotations/redaction/{annotationId} | Read document page redaction annotation by ID. |
| PdfApi | getScreenAnnotation | GET /pdf/{name}/annotations/screen/{annotationId} | Read document page screen annotation by ID. |
| PdfApi | getScreenAnnotationData | GET /pdf/{name}/annotations/screen/{annotationId}/data | Read document page screen annotation by ID. |
| PdfApi | getSoundAnnotation | GET /pdf/{name}/annotations/sound/{annotationId} | Read document page sound annotation by ID. |
| PdfApi | getSoundAnnotationData | GET /pdf/{name}/annotations/sound/{annotationId}/data | Read document page sound annotation by ID. |
| PdfApi | getSquareAnnotation | GET /pdf/{name}/annotations/square/{annotationId} | Read document page square annotation by ID. |
| PdfApi | getSquigglyAnnotation | GET /pdf/{name}/annotations/squiggly/{annotationId} | Read document page squiggly annotation by ID. |
| PdfApi | getStampAnnotation | GET /pdf/{name}/annotations/stamp/{annotationId} | Read document page stamp annotation by ID. |
| PdfApi | getStampAnnotationData | GET /pdf/{name}/annotations/stamp/{annotationId}/data | Read document page stamp annotation by ID. |
| PdfApi | getStrikeOutAnnotation | GET /pdf/{name}/annotations/strikeout/{annotationId} | Read document page StrikeOut annotation by ID. |
| PdfApi | getSvgInStorageToPdf | GET /pdf/create/svg | Convert SVG file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getTable | GET /pdf/{name}/tables/{tableId} | Read document page table by ID. |
| PdfApi | getText | GET /pdf/{name}/text | Read document text. |
| PdfApi | getTextAnnotation | GET /pdf/{name}/annotations/text/{annotationId} | Read document page text annotation by ID. |
| PdfApi | getUnderlineAnnotation | GET /pdf/{name}/annotations/underline/{annotationId} | Read document page underline annotation by ID. |
| PdfApi | getVerifySignature | GET /pdf/{name}/verifySignature | Verify signature document. |
| PdfApi | getWebInStorageToPdf | GET /pdf/create/web | Convert web page to PDF format and return resulting file in response. |
| PdfApi | getWordsPerPage | GET /pdf/{name}/pages/wordCount | Get number of words per document page. |
| PdfApi | getXfaPdfInStorageToAcroForm | GET /pdf/{name}/convert/xfatoacroform | Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content |
| PdfApi | getXmlInStorageToPdf | GET /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getXpsInStorageToPdf | GET /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | getXslFoInStorageToPdf | GET /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response. |
| PdfApi | postAppendDocument | POST /pdf/{name}/appendDocument | Append document to existing one. |
| PdfApi | postCreateField | POST /pdf/{name}/fields | Create field. |
| PdfApi | postDocumentTextReplace | POST /pdf/{name}/text/replace | Document's replace text method. |
| PdfApi | postFlattenDocument | POST /pdf/{name}/flatten | Flatten the document. |
| PdfApi | postInsertImage | POST /pdf/{name}/pages/{pageNumber}/images | Insert image to document page. |
| PdfApi | postMoveFile | POST /storage/file | Move a specific file |
| PdfApi | postMoveFolder | POST /storage/folder | Move a specific folder |
| PdfApi | postMovePage | POST /pdf/{name}/pages/{pageNumber}/movePage | Move page to new position. |
| PdfApi | postOptimizeDocument | POST /pdf/{name}/optimize | Optimize document. |
| PdfApi | postPageCaretAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/caret | Add document page caret annotations. |
| PdfApi | postPageCircleAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/circle | Add document page circle annotations. |
| PdfApi | postPageFileAttachmentAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/fileattachment | Add document page FileAttachment annotations. |
| PdfApi | postPageFreeTextAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/freetext | Add document page free text annotations. |
| PdfApi | postPageHighlightAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/highlight | Add document page highlight annotations. |
| PdfApi | postPageImageStamps | POST /pdf/{name}/pages/{pageNumber}/stamps/image | Add document page image stamps. |
| PdfApi | postPageInkAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/ink | Add document page ink annotations. |
| PdfApi | postPageLineAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/line | Add document page line annotations. |
| PdfApi | postPageLinkAnnotations | POST /pdf/{name}/pages/{pageNumber}/links | Add document page link annotations. |
| PdfApi | postPageMovieAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/movie | Add document page movie annotations. |
| PdfApi | postPagePdfPageStamps | POST /pdf/{name}/pages/{pageNumber}/stamps/pdfpage | Add document pdf page stamps. |
| PdfApi | postPagePolygonAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/polygon | Add document page polygon annotations. |
| PdfApi | postPagePolyLineAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/polyline | Add document page polyline annotations. |
| PdfApi | postPageRedactionAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/redaction | Add document page redaction annotations. |
| PdfApi | postPageScreenAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/screen | Add document page screen annotations. |
| PdfApi | postPageSoundAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/sound | Add document page sound annotations. |
| PdfApi | postPageSquareAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/square | Add document page square annotations. |
| PdfApi | postPageSquigglyAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/squiggly | Add document page squiggly annotations. |
| PdfApi | postPageStampAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/stamp | Add document page stamp annotations. |
| PdfApi | postPageStrikeOutAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/strikeout | Add document page StrikeOut annotations. |
| PdfApi | postPageTextAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/text | Add document page text annotations. |
| PdfApi | postPageTextReplace | POST /pdf/{name}/pages/{pageNumber}/text/replace | Page's replace text method. |
| PdfApi | postPageTextStamps | POST /pdf/{name}/pages/{pageNumber}/stamps/text | Add document page text stamps. |
| PdfApi | postPageUnderlineAnnotations | POST /pdf/{name}/pages/{pageNumber}/annotations/underline | Add document page underline annotations. |
| PdfApi | postPopupAnnotation | POST /pdf/{name}/annotations/{annotationId}/popup | Add document popup annotations. |
| PdfApi | postSignDocument | POST /pdf/{name}/sign | Sign document. |
| PdfApi | postSignPage | POST /pdf/{name}/pages/{pageNumber}/sign | Sign page. |
| PdfApi | postSplitDocument | POST /pdf/{name}/split | Split document to parts. |
| PdfApi | putAddNewPage | PUT /pdf/{name}/pages | Add new page to end of the document. |
| PdfApi | putAddText | PUT /pdf/{name}/pages/{pageNumber}/text | Add text to PDF document page. |
| PdfApi | putAnnotationsFlatten | PUT /pdf/{name}/annotations/flatten | Flattens the annotations of the specified types |
| PdfApi | putCaretAnnotation | PUT /pdf/{name}/annotations/caret/{annotationId} | Replace document caret annotation |
| PdfApi | putCircleAnnotation | PUT /pdf/{name}/annotations/circle/{annotationId} | Replace document circle annotation |
| PdfApi | putCreate | PUT /storage/file | Upload a specific file |
| PdfApi | putCreateDocument | PUT /pdf/{name} | Create empty document. |
| PdfApi | putCreateFolder | PUT /storage/folder | Create the folder |
| PdfApi | putEpubInStorageToPdf | PUT /pdf/{name}/create/epub | Convert EPUB file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putFieldsFlatten | PUT /pdf/{name}/fields/flatten | Flatten form fields in document. |
| PdfApi | putFileAttachmentAnnotation | PUT /pdf/{name}/annotations/fileattachment/{annotationId} | Replace document FileAttachment annotation |
| PdfApi | putFileAttachmentAnnotationDataExtract | PUT /pdf/{name}/annotations/fileattachment/{annotationId}/data/extract | Extract document FileAttachment annotation content to storage |
| PdfApi | putFreeTextAnnotation | PUT /pdf/{name}/annotations/freetext/{annotationId} | Replace document free text annotation |
| PdfApi | putHighlightAnnotation | PUT /pdf/{name}/annotations/highlight/{annotationId} | Replace document highlight annotation |
| PdfApi | putHtmlInStorageToPdf | PUT /pdf/{name}/create/html | Convert HTML file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putImageExtractAsGif | PUT /pdf/{name}/images/{imageId}/extract/gif | Extract document image in GIF format to folder |
| PdfApi | putImageExtractAsJpeg | PUT /pdf/{name}/images/{imageId}/extract/jpeg | Extract document image in JPEG format to folder |
| PdfApi | putImageExtractAsPng | PUT /pdf/{name}/images/{imageId}/extract/png | Extract document image in PNG format to folder |
| PdfApi | putImageExtractAsTiff | PUT /pdf/{name}/images/{imageId}/extract/tiff | Extract document image in TIFF format to folder |
| PdfApi | putImageInStorageToPdf | PUT /pdf/{name}/create/images | Convert image file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putImagesExtractAsGif | PUT /pdf/{name}/pages/{pageNumber}/images/extract/gif | Extract document images in GIF format to folder. |
| PdfApi | putImagesExtractAsJpeg | PUT /pdf/{name}/pages/{pageNumber}/images/extract/jpeg | Extract document images in JPEG format to folder. |
| PdfApi | putImagesExtractAsPng | PUT /pdf/{name}/pages/{pageNumber}/images/extract/png | Extract document images in PNG format to folder. |
| PdfApi | putImagesExtractAsTiff | PUT /pdf/{name}/pages/{pageNumber}/images/extract/tiff | Extract document images in TIFF format to folder. |
| PdfApi | putInkAnnotation | PUT /pdf/{name}/annotations/ink/{annotationId} | Replace document ink annotation |
| PdfApi | putLaTeXInStorageToPdf | PUT /pdf/{name}/create/latex | Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putLineAnnotation | PUT /pdf/{name}/annotations/line/{annotationId} | Replace document line annotation |
| PdfApi | putLinkAnnotation | PUT /pdf/{name}/links/{linkId} | Replace document page link annotations |
| PdfApi | putMergeDocuments | PUT /pdf/{name}/merge | Merge a list of documents. |
| PdfApi | putMhtInStorageToPdf | PUT /pdf/{name}/create/mht | Convert MHT file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putMovieAnnotation | PUT /pdf/{name}/annotations/movie/{annotationId} | Replace document movie annotation |
| PdfApi | putPageAddStamp | PUT /pdf/{name}/pages/{pageNumber}/stamp | Add page stamp. |
| PdfApi | putPageConvertToBmp | PUT /pdf/{name}/pages/{pageNumber}/convert/bmp | Convert document page to bmp image and upload resulting file to storage. |
| PdfApi | putPageConvertToEmf | PUT /pdf/{name}/pages/{pageNumber}/convert/emf | Convert document page to emf image and upload resulting file to storage. |
| PdfApi | putPageConvertToGif | PUT /pdf/{name}/pages/{pageNumber}/convert/gif | Convert document page to gif image and upload resulting file to storage. |
| PdfApi | putPageConvertToJpeg | PUT /pdf/{name}/pages/{pageNumber}/convert/jpeg | Convert document page to Jpeg image and upload resulting file to storage. |
| PdfApi | putPageConvertToPng | PUT /pdf/{name}/pages/{pageNumber}/convert/png | Convert document page to png image and upload resulting file to storage. |
| PdfApi | putPageConvertToTiff | PUT /pdf/{name}/pages/{pageNumber}/convert/tiff | Convert document page to Tiff image and upload resulting file to storage. |
| PdfApi | putPclInStorageToPdf | PUT /pdf/{name}/create/pcl | Convert PCL file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putPdfInRequestToDoc | PUT /pdf/convert/doc | Converts PDF document (in request content) to DOC format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToEpub | PUT /pdf/convert/epub | Converts PDF document (in request content) to EPUB format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToHtml | PUT /pdf/convert/html | Converts PDF document (in request content) to Html format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToLaTeX | PUT /pdf/convert/latex | Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToMobiXml | PUT /pdf/convert/mobixml | Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToPdfA | PUT /pdf/convert/pdfa | Converts PDF document (in request content) to PdfA format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToPptx | PUT /pdf/convert/pptx | Converts PDF document (in request content) to PPTX format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToSvg | PUT /pdf/convert/svg | Converts PDF document (in request content) to SVG format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToTiff | PUT /pdf/convert/tiff | Converts PDF document (in request content) to TIFF format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToXls | PUT /pdf/convert/xls | Converts PDF document (in request content) to XLS format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToXml | PUT /pdf/convert/xml | Converts PDF document (in request content) to XML format and uploads resulting file to storage. |
| PdfApi | putPdfInRequestToXps | PUT /pdf/convert/xps | Converts PDF document (in request content) to XPS format and uploads resulting file to storage. |
| PdfApi | putPdfInStorageToDoc | PUT /pdf/{name}/convert/doc | Converts PDF document (located on storage) to DOC format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToEpub | PUT /pdf/{name}/convert/epub | Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToHtml | PUT /pdf/{name}/convert/html | Converts PDF document (located on storage) to Html format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToLaTeX | PUT /pdf/{name}/convert/latex | Converts PDF document (located on storage) to LaTeX format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToMobiXml | PUT /pdf/{name}/convert/mobixml | Converts PDF document (located on storage) to MOBIXML format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToPdfA | PUT /pdf/{name}/convert/pdfa | Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToPptx | PUT /pdf/{name}/convert/pptx | Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToSvg | PUT /pdf/{name}/convert/svg | Converts PDF document (located on storage) to SVG format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToTiff | PUT /pdf/{name}/convert/tiff | Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToXls | PUT /pdf/{name}/convert/xls | Converts PDF document (located on storage) to XLS format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToXml | PUT /pdf/{name}/convert/xml | Converts PDF document (located on storage) to XML format and uploads resulting file to storage |
| PdfApi | putPdfInStorageToXps | PUT /pdf/{name}/convert/xps | Converts PDF document (located on storage) to XPS format and uploads resulting file to storage |
| PdfApi | putPolygonAnnotation | PUT /pdf/{name}/annotations/polygon/{annotationId} | Replace document polygon annotation |
| PdfApi | putPolyLineAnnotation | PUT /pdf/{name}/annotations/polyline/{annotationId} | Replace document polyline annotation |
| PdfApi | putPopupAnnotation | PUT /pdf/{name}/annotations/popup/{annotationId} | Replace document popup annotation |
| PdfApi | putPrivileges | PUT /pdf/{name}/privileges | Update privilege document. |
| PdfApi | putPsInStorageToPdf | PUT /pdf/{name}/create/ps | Convert PS file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putRedactionAnnotation | PUT /pdf/{name}/annotations/redaction/{annotationId} | Replace document redaction annotation |
| PdfApi | putReplaceImage | PUT /pdf/{name}/images/{imageId} | Replace document image. |
| PdfApi | putScreenAnnotation | PUT /pdf/{name}/annotations/screen/{annotationId} | Replace document screen annotation |
| PdfApi | putScreenAnnotationDataExtract | PUT /pdf/{name}/annotations/screen/{annotationId}/data/extract | Extract document screen annotation content to storage |
| PdfApi | putSearchableDocument | PUT /pdf/{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document. |
| PdfApi | putSetProperty | PUT /pdf/{name}/documentproperties/{propertyName} | Add/update document property. |
| PdfApi | putSoundAnnotation | PUT /pdf/{name}/annotations/sound/{annotationId} | Replace document sound annotation |
| PdfApi | putSoundAnnotationDataExtract | PUT /pdf/{name}/annotations/sound/{annotationId}/data/extract | Extract document sound annotation content to storage |
| PdfApi | putSquareAnnotation | PUT /pdf/{name}/annotations/square/{annotationId} | Replace document square annotation |
| PdfApi | putSquigglyAnnotation | PUT /pdf/{name}/annotations/squiggly/{annotationId} | Replace document squiggly annotation |
| PdfApi | putStampAnnotation | PUT /pdf/{name}/annotations/stamp/{annotationId} | Replace document stamp annotation |
| PdfApi | putStampAnnotationDataExtract | PUT /pdf/{name}/annotations/stamp/{annotationId}/data/extract | Extract document stamp annotation content to storage |
| PdfApi | putStrikeOutAnnotation | PUT /pdf/{name}/annotations/strikeout/{annotationId} | Replace document StrikeOut annotation |
| PdfApi | putSvgInStorageToPdf | PUT /pdf/{name}/create/svg | Convert SVG file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putTextAnnotation | PUT /pdf/{name}/annotations/text/{annotationId} | Replace document text annotation |
| PdfApi | putUnderlineAnnotation | PUT /pdf/{name}/annotations/underline/{annotationId} | Replace document underline annotation |
| PdfApi | putUpdateField | PUT /pdf/{name}/fields/{fieldName} | Update field. |
| PdfApi | putUpdateFields | PUT /pdf/{name}/fields | Update fields. |
| PdfApi | putWebInStorageToPdf | PUT /pdf/{name}/create/web | Convert web page to PDF format and upload resulting file to storage. |
| PdfApi | putXfaPdfInRequestToAcroForm | PUT /pdf/convert/xfatoacroform | Converts PDF document which contatins XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage. |
| PdfApi | putXfaPdfInStorageToAcroForm | PUT /pdf/{name}/convert/xfatoacroform | Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage |
| PdfApi | putXmlInStorageToPdf | PUT /pdf/{name}/create/xml | Convert XML file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putXpsInStorageToPdf | PUT /pdf/{name}/create/xps | Convert XPS file (located on storage) to PDF format and upload resulting file to storage. |
| PdfApi | putXslFoInStorageToPdf | PUT /pdf/{name}/create/xslfo | Convert XslFo file (located on storage) to PDF format and upload resulting file to storage. |
Documentation for Models
| Class | Description |
|---|---|
| Annotation | Provides annotation. |
| AnnotationFlags | A set of flags specifying various characteristics of the annotation. |
| AnnotationInfo | Provides annotation. |
| AnnotationsInfo | Object representing a list of annotation info objects. |
| AnnotationsInfoResponse | Represents multiple annotations info reponse |
| AnnotationState | The enumeration of states to which the original annotation can be set. |
| AnnotationType | |
| AntialiasingProcessingType | This enum describes possible antialiasing measures during conversion |
| AppendDocument | Class for appendDocument service request building. |
| AsposeResponse | Base class for all responses. |
| Attachment | Provides link to attachment. |
| AttachmentResponse | Represents response containing single attachment info |
| Attachments | Represents list of attachment. |
| AttachmentsResponse | Represents response containing multiple attachments info |
| CapStyle | Style of line ending of Ink annotation line. |
| CaptionPosition | Enumeration of the annotation’s caption positioning. |
| CaretAnnotation | Provides CaretAnnotation. |
| CaretAnnotationResponse | Represents response containing single caret annotation object |
| CaretAnnotations | Object representing a list of caret annotations. |
| CaretAnnotationsResponse | Represents response containing multiple caret annotation objects |
| CaretSymbol | A symbol to be associated with the caret. |
| CellRecognized | |
| CircleAnnotation | Provides CircleAnnotation. |
| CircleAnnotationResponse | Represents response containing single circle annotation object |
| CircleAnnotations | Object representing a list of circle annotations. |
| CircleAnnotationsResponse | Represents response containing multiple circle annotation objects |
| Color | Represents color DTO. |
| ColorDepth | Used to specify the parameter value passed to a Tiff image device. |
| CommonFigureAnnotation | Provides CommonFigureAnnotation. |
| CompressionType | Used to specify the parameter value passed to a Tiff image device. |
| DiscUsage | |
| DiscUsageResponse | |
| DocFormat | Allows to specify .doc or .docx file format. |
| DocRecognitionMode | Allows to control how a PDF document is converted into a word processing document. |
| Document | Represents document DTO. |
| DocumentPageResponse | Represents response containing single page info |
| DocumentPagesResponse | Represents response containing multiple pages info |
| DocumentPrivilege | Represents the privileges for accessing Pdf file./>. |
| DocumentProperties | Represents list of PDF document properties. |
| DocumentPropertiesResponse | Represents response containing multiple document properties info |
| DocumentProperty | Pdf document property. |
| DocumentPropertyResponse | Represents response containing single document property info |
| DocumentResponse | Represents response containing document info |
| EpubRecognitionMode | When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content. |
| Field | Represents form field. |
| FieldResponse | Represents response containing single field info |
| Fields | Represents list of form fields. |
| FieldsResponse | Represents response containing multiple fields info |
| FieldType | Represents an enumeration of available field types. |
| File | Represents file DTO. |
| FileAttachmentAnnotation | Provides FileAttachmentAnnotation. |
| FileAttachmentAnnotationResponse | Represents response containing single FileAttachment annotation object |
| FileAttachmentAnnotations | Object representing a list of FileAttachment annotations. |
| FileAttachmentAnnotationsResponse | Represents response containing multiple FileAttachment annotation objects |
| FileExist | |
| FileExistResponse | |
| FileIcon | An icon to be used in displaying the annotation. |
| FilesResponse | |
| FileVersion | |
| FileVersionsResponse | |
| FontEncodingRules | This enumeration defines rules which tune encoding logic |
| FontSavingModes | Enumerates modes that can be used for saving of fonts referenced in saved PDF |
| FontStyles | Specifies style information applied to text. |
| FreeTextAnnotation | Provides FreeTextAnnotation. |
| FreeTextAnnotationResponse | Represents response containing single free text annotation object |
| FreeTextAnnotations | Object representing a list of free text annotations. |
| FreeTextAnnotationsResponse | Represents response containing multiple free text annotation objects |
| FreeTextIntent | Enumerates the intents of the free text annotation. |
| HighlightAnnotation | Provides HighlightAnnotation. |
| HighlightAnnotationResponse | Represents response containing single highlight annotation object |
| HighlightAnnotations | Object representing a list of highlight annotations. |
| HighlightAnnotationsResponse | Represents response containing multiple highlight annotation objects |
| HorizontalAlignment | Describes horizontal alignment. |
| HtmlDocumentType | Represents enumeration of the Html document types. |
| HtmlMarkupGenerationModes | Sometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments. |
| Image | Represents image DTO. |
| ImageResponse | Represents response containing single image info |
| Images | Represents list of images. |
| ImageSrcType | Allows to specify image file format. |
| ImagesResponse | Represents response containing multiple images info |
| ImageStamp | Represents Pdf stamps. |
| ImageTemplate | Template of image. |
| ImageTemplatesRequest | Create document from images request. |
| InkAnnotation | Provides InkAnnotation. |
| InkAnnotationResponse | Represents response containing single ink annotation object |
| InkAnnotations | Object representing a list of ink annotations. |
| InkAnnotationsResponse | Represents response containing multiple ink annotation objects |
| Justification | Enumerates the forms of quadding (justification) to be used in displaying the annotation’s text. |
| LettersPositioningMethods | It enumerates possible modes of positioning of letters in words in result HTML |
| LineAnnotation | Provides LineAnnotation. |
| LineAnnotationResponse | Represents response containing single line annotation object |
| LineAnnotations | Object representing a list of line annotations. |
| LineAnnotationsResponse | Represents response containing multiple line annotation objects |
| LineEnding | Enumerates the line ending styles to be used in drawing the line. |
| LineIntent | Enumerates the intents of the line annotation. |
| LineSpacing | Defines line spacing specifics |
| Link | Provides information for the object link. This is supposed to be an atom:link, therefore it should have all attributes specified here http://tools.ietf.org/html/rfc4287#section-4.2.7 |
| LinkActionType | Represents list of link action types. |
| LinkAnnotation | Provides link to linkAnnotation. |
| LinkAnnotationResponse | Represents response containing single link info |
| LinkAnnotations | Object representing a list of link annotations. |
| LinkAnnotationsResponse | Represents response containing multiple links info |
| LinkElement | Represents base DTO object. |
| LinkHighlightingMode | Enumerates the annotation’s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area. |
| MarginInfo | |
| MarkupAnnotation | Provides MarkupAnnotation. |
| MergeDocuments | Documents for merging. |
| MovieAnnotation | Provides MovieAnnotation. |
| MovieAnnotationResponse | Represents response containing single movie annotation object |
| MovieAnnotations | Object representing a list of movie annotations. |
| MovieAnnotationsResponse | Represents response containing multiple movie annotation objects |
| OptimizeOptions | Represents Pdf optimize options. |
| Page | Provides link to page. |
| Pages | Represents list of pages. |
| PageWordCount | Page words count. |
| Paragraph | Represents text paragraphs as multiline text object. |
| PartsEmbeddingModes | This enum enumerates possible modes of embedding of files referenced in HTML It allows to control whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities |
| PdfAType | Allows to specify PdfA file format. |
| PdfPageStamp | Represents Pdf stamps. |
| Point | Represent point with fractional coordinates. |
| PolyAnnotation | Provides PolyAnnotation. |
| PolygonAnnotation | Provides PolygonAnnotation. |
| PolygonAnnotationResponse | Represents response containing single polygon annotation object |
| PolygonAnnotations | Object representing a list of polygon annotations. |
| PolygonAnnotationsResponse | Represents response containing multiple polygon annotation objects |
| PolyIntent | Enumerates the intents of the polygon or polyline annotation. |
| PolyLineAnnotation | Provides PolyLineAnnotation. |
| PolyLineAnnotationResponse | Represents response containing single polyline annotation object |
| PolyLineAnnotations | Object representing a list of polyline annotations. |
| PolyLineAnnotationsResponse | Represents response containing multiple polyline annotation objects |
| PopupAnnotation | Provides PopupAnnotation. |
| PopupAnnotationResponse | Represents response containing single popup annotation object |
| PopupAnnotations | Object representing a list of popup annotations. |
| PopupAnnotationsResponse | Represents response containing multiple popup annotation objects |
| PopupAnnotationWithParent | Provides PopupAnnotation. |
| Position | Represents a position object |
| RasterImagesSavingModes | Converted PDF can contain raster images(.png, *.jpeg etc.) This enum defines methods of how raster images can be handled during conversion of PDF to HTML |
| Rectangle | Represents rectangle DTO. |
| RedactionAnnotation | Provides RedactionAnnotation. |
| RedactionAnnotationResponse | Represents response containing single redaction annotation object |
| RedactionAnnotations | Object representing a list of redaction annotations. |
| RedactionAnnotationsResponse | Represents response containing multiple redaction annotation objects |
| Rotation | Enumeration of possible rotation values. |
| RowRecognized | |
| ScreenAnnotation | Provides ScreenAnnotation. |
| ScreenAnnotationResponse | Represents response containing single screen annotation object |
| ScreenAnnotations | Object representing a list of screen annotations. |
| ScreenAnnotationsResponse | Represents response containing multiple screen annotation objects |
| Segment | Represents segment of Pdf text. |
| ShapeType | This enum represents shape type for the extracted images. |
| Signature | Represents signature. |
| SignatureType | The type of signature. |
| SignatureVerifyResponse | Represent responce containing signature verification result |
| SoundAnnotation | Provides SoundAnnotation. |
| SoundAnnotationResponse | Represents response containing single Sound annotation object |
| SoundAnnotations | Object representing a list of Sound annotations. |
| SoundAnnotationsResponse | Represents response containing multiple sound annotation objects |
| SoundEncoding | The encoding format for the sample data. |
| SoundIcon | An icon to be used in displaying the annotation. |
| SplitResult | Represents split result object. |
| SplitResultDocument | Represents split result document, |
| SplitResultResponse | Represents responce containing split result. |
| SquareAnnotation | Provides SquareAnnotation. |
| SquareAnnotationResponse | Represents response containing single square annotation object |
| SquareAnnotations | Object representing a list of square annotations. |
| SquareAnnotationsResponse | Represents response containing multiple square annotation objects |
| SquigglyAnnotation | Provides SquigglyAnnotation. |
| SquigglyAnnotationResponse | Represents response containing single squiggly-underline annotation object |
| SquigglyAnnotations | Object representing a list of squiggly-underline annotations. |
| SquigglyAnnotationsResponse | Represents response containing multiple squiggly-underline annotation objects |
| Stamp | Represents Pdf stamps. |
| StampAnnotation | Provides StampAnnotation. |
| StampAnnotationResponse | Represents response containing single stamp annotation object |
| StampAnnotations | Object representing a list of stamp annotations. |
| StampAnnotationsResponse | Represents response containing multiple stamp annotation objects |
| StampBase | Represents Pdf stamps. |
| StampIcon | Enumerates the icons to be used in displaying the annotation. |
| StampInfo | Provides stamp info. |
| StampsInfo | Object representing a list of stamps. |
| StampsInfoResponse | Represents multiple stamps info reponse |
| StampType | Represents enumeration of the stamp types. |
| StorageExistResponse | |
| StrikeOutAnnotation | Provides StrikeOutAnnotation. |
| StrikeOutAnnotationResponse | Represents response containing single strikeout annotation object |
| StrikeOutAnnotations | Object representing a list of strikeout annotations. |
| StrikeOutAnnotationsResponse | Represents response containing multiple strikeout annotation objects |
| TableRecognized | |
| TableRecognizedResponse | Represents response containing single recognized table |
| TablesRecognized | Represents list of recognized tables. |
| TablesRecognizedResponse | Represents response containing multiple tables info |
| TextAnnotation | Provides TextAnnotation. |
| TextAnnotationResponse | Represents response containing single text annotation object |
| TextAnnotations | Object representing a list of text annotations. |
| TextAnnotationsResponse | Represents response containing multiple text annotation objects |
| TextHorizontalAlignment | Describes text horizontal alignment. |
| TextIcon | Enumerates the icons to be used in displaying the annotation. |
| TextLine | A line of text to be inserted into paragraph. |
| TextRect | Represents text occurrence. |
| TextRects | Represents multiple text occurrences DTO. |
| TextRectsResponse | Represents response containing multiple text occurrences info |
| TextReplace | Single text replacement setting. |
| TextReplaceListRequest | Multiple text replacements request. |
| TextReplaceResponse | Represents response containing the result of text replacement |
| TextStamp | Represents Pdf stamps. |
| TextState | Represents a text state of a text |
| TextStyle | Represents a text style of a text |
| UnderlineAnnotation | Provides UnderlineAnnotation. |
| UnderlineAnnotationResponse | Represents response containing single underline annotation object |
| UnderlineAnnotations | Object representing a list of underline annotations. |
| UnderlineAnnotationsResponse | Represents response containing multiple underline annotation objects |
| VerticalAlignment | Enumeration of possible vertical alignment values. |
| WordCount | Number of words per document pages. |
| WordCountResponse | Number of words per document pages. |
| WrapMode | Defines word wrapping strategies |