PHP library for communicating with the Aspose.Pdf for Cloud API
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.swagger-codegen
docs
src/Aspose/PDF
testData
tests/Aspose/PDF
.gitattributes
.gitignore
.swagger-codegen-ignore
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

Aspose.PDF Cloud

  • API version: 2.0
  • Package version: 18.10.0

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.

Requirements

PHP 5.4.0 and later

Unit Tests

Aspose PDF SDK includes a suite of unit tests within the "tests" subdirectory. These Unit Tests also serves as examples of how to use the Aspose PDF SDK.

To run the unit tests:

composer install
./vendor/bin/phpunit

Usage

APIs of this SDK can be called as follows:

<?php
use Aspose\PDF\Api\PdfApi;
use Aspose\PDF\Configuration;

class PdfApiUsage
{

    protected $pdfApi;
    protected $tempFolder;
    protected $config;

    protected function setUp()
    {
        // Get App key and App SID from https://cloud.aspose.com
        $appSid = '';
        $appKey = '';

        $this->tempFolder = 'TempPdfCloud';
        
        $this->config = new Configuration();
        $this->config->setAppKey($appKey);
        $this->config->setAppSid($appSid);

        $this->pdfApi = new PdfApi(null, $this->config);
    }

    public function testGetPageAnnotations()
    {
        $name = 'PdfWithAnnotations.pdf';
        $pageNumber = 2;

        $response = $this->pdfApi->getPageAnnotations($name, $pageNumber, null, $this->tempFolder);
    }
}

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 deleteField DELETE /pdf/{name}/fields/{fieldName} Delete document field by name.
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 deleteProperties DELETE /pdf/{name}/documentproperties Delete custom document properties.
PdfApi deleteProperty DELETE /pdf/{name}/documentproperties/{propertyName} Delete document property.
PdfApi getCircleAnnotation GET /pdf/{name}/annotations/circle/{annotationId} Read document page circle annotation by ID.
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 getDocumentCircleAnnotations GET /pdf/{name}/annotations/circle Read document circle annotations.
PdfApi getDocumentFreeTextAnnotations GET /pdf/{name}/annotations/freetext Read document free text annotations.
PdfApi getDocumentLineAnnotations GET /pdf/{name}/annotations/line Read document line annotations.
PdfApi getDocumentPolygonAnnotations GET /pdf/{name}/annotations/polygon Read document polygon annotations.
PdfApi getDocumentPolyLineAnnotations GET /pdf/{name}/annotations/polyline Read document polyline annotations.
PdfApi getDocumentProperties GET /pdf/{name}/documentproperties Read document properties.
PdfApi getDocumentProperty GET /pdf/{name}/documentproperties/{propertyName} Read document property by name.
PdfApi getDocumentSquareAnnotations GET /pdf/{name}/annotations/square Read document square annotations.
PdfApi getDocumentTextAnnotations GET /pdf/{name}/annotations/text Read document text 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 getFreeTextAnnotation GET /pdf/{name}/annotations/freetext/{annotationId} Read document page free text 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 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 getMhtInStorageToPdf GET /pdf/create/mht Convert MHT file (located on storage) to PDF format and return resulting file in response.
PdfApi getPage GET /pdf/{name}/pages/{pageNumber} Read document page info.
PdfApi getPageAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
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 getPageFreeTextAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/freetext Read document page free text 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 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 getPages GET /pdf/{name}/pages Read document pages info.
PdfApi getPageSquareAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/square Read document page square annotations.
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 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 getPsInStorageToPdf GET /pdf/create/ps Convert PS file (located on storage) to PDF format and return resulting file in response.
PdfApi getSquareAnnotation GET /pdf/{name}/annotations/square/{annotationId} Read document page square 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 getText GET /pdf/{name}/text Read document text.
PdfApi getTextAnnotation GET /pdf/{name}/annotations/text/{annotationId} Read document page text 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 postInsertImage POST /pdf/{name}/pages/{pageNumber}/images Insert image to document page.
PdfApi postMovePage POST /pdf/{name}/pages/{pageNumber}/movePage Move page to new position.
PdfApi postOptimizeDocument POST /pdf/{name}/optimize Optimize document.
PdfApi postPageCircleAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/circle Add document page circle annotations.
PdfApi postPageFreeTextAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/freetext Add document page free text 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 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 postPageSquareAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/square Add document page square 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 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 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 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 putFreeTextAnnotation PUT /pdf/{name}/annotations/freetext/{annotationId} Replace document free text 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 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 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 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 putReplaceImage PUT /pdf/{name}/images/{imageId} Replace document image.
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 putSquareAnnotation PUT /pdf/{name}/annotations/square/{annotationId} Replace document square 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 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 List of annotations.
AnnotationsInfoResponse
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
Attachments List of attachment.
AttachmentsResponse
CaptionPosition Enumeration of the annotation?s caption positioning.
CircleAnnotation Provides CircleAnnotation.
CircleAnnotationResponse
CircleAnnotations List of annotations.
CircleAnnotationsResponse
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.
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
DocumentPagesResponse
DocumentPrivilege Represents the privileges for accessing Pdf file./>.
DocumentProperties Pdf document properties.
DocumentPropertiesResponse
DocumentProperty Pdf document property.
DocumentPropertyResponse
DocumentResponse
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
Fields List of form fields.
FieldsResponse
FieldType Represents an enumeration of available field types.
File Represents file DTO.
FilesResponse
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
FreeTextAnnotations List of annotations.
FreeTextAnnotationsResponse
FreeTextIntent Enumerates the intents of the free text annotation.
HorizontalAlignment
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
Images List of page images.
ImageSrcType Allows to specify image file format.
ImagesResponse
ImageTemplate Template of image.
ImageTemplatesRequest Create document from images request.
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
LineAnnotations List of annotations.
LineAnnotationsResponse
LineEnding Enumerates the line ending styles to be used in drawing the line.
LineIntent Enumerates the intents of the line annotation.
LineSpacing
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
LinkAnnotations List of LinkAnnotations.
LinkAnnotationsResponse
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.
OptimizeOptions Represents Pdf optimize options.
Page Provides link to page.
Pages List of pages.
PageWordCount Page words count.
Paragraph Paragraph DTO for add text functionality.
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.
Point Represent point with fractional coordinates.
PolyAnnotation Provides PolyAnnotation.
PolygonAnnotation Provides PolygonAnnotation.
PolygonAnnotationResponse
PolygonAnnotations List of annotations.
PolygonAnnotationsResponse
PolyIntent Enumerates the intents of the polygon or polyline annotation.
PolyLineAnnotation Provides PolyLineAnnotation.
PolyLineAnnotationResponse
PolyLineAnnotations List of annotations.
PolyLineAnnotationsResponse
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
RectanglePdf Represents rectangle DTO.
Rotation Enumeration of possible rotation values.
Segment
ShapeType This enum represents shape type for the extracted images.
Signature
SignatureType
SignatureVerifyResponse Returns also a message.
SplitResult Represents split result object.
SplitResultDocument Represents split result document,
SplitResultResponse Represents split result object.
SquareAnnotation Provides SquareAnnotation.
SquareAnnotationResponse
SquareAnnotations List of annotations.
SquareAnnotationsResponse
Stamp Represents Pdf stamps.
StampType Represents enumeration of the stamp types.
TextAnnotation Provides TextAnnotation.
TextAnnotationResponse
TextAnnotations List of annotations.
TextAnnotationsResponse
TextHorizontalAlignment
TextIcon Enumerates the icons to be used in displaying the annotation.
TextLine A line of text to be inserted into .
TextRect Represents text DTO.
TextRects Represents text items DTO.
TextRectsResponse
TextReplace Single text replacement setting.
TextReplaceListRequest Multiple text replacements request.
TextReplaceResponse
TextState Represents a text state of a text
TextStyle Represents a text style of a text
VerticalAlignment Enumeration of possible vertical alignment values.
WordCount Number of words per document pages.
WordCountResponse Number of words per document pages.
WrapMode