public class PdfApi extends Object
Constructor and Description |
---|
PdfApi(String apiKey,
String appSid) |
PdfApi(String apiKey,
String appSid,
boolean isDebug) |
PdfApi(String basePath,
String apiKey,
String appSid) |
PdfApi(String basePath,
String apiKey,
String appSid,
boolean isDebug) |
Modifier and Type | Method and Description |
---|---|
SaaSposeResponse |
DeletePage(String name,
Integer pageNumber,
String storage,
String folder)
DeletePage
Delete document page by its number.
|
SaaSposeResponse |
DeleteProperties(String name,
String storage,
String folder)
DeleteProperties
Delete document properties.
|
SaaSposeResponse |
DeleteProperty(String name,
String propertyName,
String storage,
String folder)
DeleteProperty
Delete document property.
|
String |
getBasePath() |
ResponseMessage |
GetDocument(String name,
String storage,
String folder)
GetDocument
Read common document info.
|
AttachmentResponse |
GetDocumentAttachmentByIndex(String name,
Integer attachmentIndex,
String storage,
String folder)
GetDocumentAttachmentByIndex
Read document attachment info by its index.
|
AttachmentsResponse |
GetDocumentAttachments(String name,
String storage,
String folder)
GetDocumentAttachments
Read document attachments info.
|
BookmarksResponse |
GetDocumentBookmarks(String name,
String storage,
String folder)
GetDocumentBookmarks
Read document bookmarks.
|
BookmarkResponse |
GetDocumentBookmarksChildren(String name,
String bookmarkPath,
String storage,
String folder)
GetDocumentBookmarksChildren
Read document bookmark/bookmarks (including children).
|
DocumentPropertiesResponse |
GetDocumentProperties(String name,
String storage,
String folder)
GetDocumentProperties
Read document properties.
|
DocumentPropertyResponse |
GetDocumentProperty(String name,
String propertyName,
String storage,
String folder)
GetDocumentProperty
Read document property by name.
|
ResponseMessage |
GetDocumentWithFormat(String name,
String format,
String storage,
String folder,
String outPath)
GetDocumentWithFormat
Read common document info or convert to some format if the format specified.
|
ResponseMessage |
GetDownloadDocumentAttachmentByIndex(String name,
Integer attachmentIndex,
String storage,
String folder)
GetDownloadDocumentAttachmentByIndex
Download document attachment content by its index.
|
BarcodeResponseList |
GetExtractBarcodes(String name,
Integer pageNumber,
Integer imageNumber,
String storage,
String folder)
GetExtractBarcodes
Recognize barcodes.
|
FieldResponse |
GetField(String name,
String fieldName,
String storage,
String folder)
GetField
Get document field by name.
|
FieldsResponse |
GetFields(String name,
String storage,
String folder)
GetFields
Get document fields.
|
TextItemsResponse |
GetFragment(String name,
Integer pageNumber,
Integer fragmentNumber,
String withEmpty,
String storage,
String folder)
GetFragment
Read page fragment.
|
TextItemsResponse |
GetFragments(String name,
Integer pageNumber,
String withEmpty,
String storage,
String folder)
GetFragments
Read page fragments.
|
TextFormatResponse |
GetFragmentTextFormat(String name,
Integer pageNumber,
Integer fragmentNumber,
String storage,
String folder)
GetFragmentTextFormat
Read page fragment text format.
|
ResponseMessage |
GetImage(String name,
Integer pageNumber,
Integer imageNumber,
String storage,
String folder)
GetImage
Read document image by number.
|
ImagesResponse |
GetImages(String name,
Integer pageNumber,
String storage,
String folder)
GetImages
Read document images.
|
ResponseMessage |
GetImageWithFormat(String name,
Integer pageNumber,
Integer imageNumber,
String format,
Integer width,
Integer height,
String storage,
String folder)
GetImageWithFormat
Extract document image in format specified.
|
ApiInvoker |
getInvoker() |
ResponseMessage |
GetPage(String name,
Integer pageNumber,
String storage,
String folder)
GetPage
Read document page info.
|
AnnotationResponse |
GetPageAnnotation(String name,
Integer pageNumber,
Integer annotationNumber,
String storage,
String folder)
GetPageAnnotation
Read document page annotation by its number.
|
AnnotationsResponse |
GetPageAnnotations(String name,
Integer pageNumber,
String storage,
String folder)
GetPageAnnotations
Read documant page annotations.
|
LinkAnnotationResponse |
GetPageLinkAnnotationByIndex(String name,
Integer pageNumber,
Integer linkIndex,
String storage,
String folder)
GetPageLinkAnnotationByIndex
Read document page link annotation by its index.
|
LinkAnnotationsResponse |
GetPageLinkAnnotations(String name,
Integer pageNumber,
String storage,
String folder)
GetPageLinkAnnotations
Read document page link annotations.
|
DocumentPagesResponse |
GetPages(String name,
String storage,
String folder)
GetPages
Read document pages info.
|
TextItemsResponse |
GetPageTextItems(String name,
Integer pageNumber,
String withEmpty,
String storage,
String folder)
GetPageTextItems
Read page text items.
|
ResponseMessage |
GetPageWithFormat(String name,
Integer pageNumber,
String format,
Integer width,
Integer height,
String storage,
String folder)
GetPageWithFormat
Convert document page to format specified.
|
TextItemResponse |
GetSegment(String name,
Integer pageNumber,
Integer fragmentNumber,
Integer segmentNumber,
String storage,
String folder)
GetSegment
Read segment.
|
TextItemsResponse |
GetSegments(String name,
Integer pageNumber,
Integer fragmentNumber,
String withEmpty,
String storage,
String folder)
GetSegments
Read fragment segments.
|
TextFormatResponse |
GetSegmentTextFormat(String name,
Integer pageNumber,
Integer fragmentNumber,
Integer segmentNumber,
String storage,
String folder)
GetSegmentTextFormat
Read segment text format.
|
TextItemsResponse |
GetTextItems(String name,
String withEmpty,
String storage,
String folder)
GetTextItems
Read document text items.
|
WordCountResponse |
GetWordsPerPage(String name,
String storage,
String folder)
GetWordsPerPage
Get number of words per document page.
|
DocumentResponse |
PostAppendDocument(String name,
String appendFile,
Integer startPage,
Integer endPage,
String storage,
String folder,
AppendDocument body)
PostAppendDocument
Append document to existing one.
|
SaaSposeResponse |
PostCreateField(String name,
Integer page,
String storage,
String folder,
Field body)
PostCreateField
Create field.
|
DocumentTextReplaceResponse |
PostDocumentReplaceText(String name,
String storage,
String folder,
TextReplace body)
PostDocumentReplaceText
Document's replace text method.
|
DocumentTextReplaceResponse |
PostDocumentReplaceTextList(String name,
String storage,
String folder,
TextReplaceListRequest body)
PostDocumentReplaceTextList
Document's replace text method.
|
SaaSposeResponse |
PostMovePage(String name,
Integer pageNumber,
Integer newIndex,
String storage,
String folder)
PostMovePage
Move page to new position.
|
PageTextReplaceResponse |
PostPageReplaceText(String name,
Integer pageNumber,
String storage,
String folder,
TextReplace body)
PostPageReplaceText
Page's replace text method.
|
PageTextReplaceResponse |
PostPageReplaceTextList(String name,
Integer pageNumber,
String storage,
String folder,
TextReplaceListRequest body)
PostPageReplaceTextList
Page's replace text method.
|
ImageResponse |
PostReplaceImage(String name,
Integer pageNumber,
Integer imageNumber,
String imageFile,
String storage,
String folder,
File file)
PostReplaceImage
Replace document image.
|
SaaSposeResponse |
PostSignDocument(String name,
String storage,
String folder,
Signature body)
PostSignDocument
Sign document.
|
SaaSposeResponse |
PostSignPage(String name,
Integer pageNumber,
String storage,
String folder,
Signature body)
PostSignPage
Sign page.
|
SplitResultResponse |
PostSplitDocument(String name,
String format,
Integer from,
Integer to,
String storage,
String folder)
PostSplitDocument
Split document to parts.
|
DocumentPagesResponse |
PutAddNewPage(String name,
String storage,
String folder)
PutAddNewPage
Add new page to end of the document.
|
ResponseMessage |
PutConvertDocument(String format,
String url,
String outPath,
File file)
PutConvertDocument
Convert document from request content to format specified.
|
DocumentResponse |
PutCreateDocument(String name,
String templateFile,
String dataFile,
String templateType,
String storage,
String folder)
PutCreateDocument
Create new document.
|
SaaSposeResponse |
PutDocumentSaveAsTiff(String name,
String resultFile,
Float brightness,
String compression,
String colorDepth,
Integer leftMargin,
Integer rightMargin,
Integer topMargin,
Integer bottomMargin,
String orientation,
Boolean skipBlankPages,
Integer width,
Integer height,
Integer xResolution,
Integer yResolution,
Integer pageIndex,
Integer pageCount,
String storage,
String folder,
TiffExportOptions body)
PutDocumentSaveAsTiff
Save document as Tiff image.
|
DocumentResponse |
PutMergeDocuments(String name,
String storage,
String folder,
MergeDocuments body)
PutMergeDocuments
Merge a list of documents.
|
SaaSposeResponse |
PutPageAddStamp(String name,
Integer pageNumber,
String storage,
String folder,
Stamp body)
PutPageAddStamp
Add page stamp.
|
DocumentPropertyResponse |
PutSetProperty(String name,
String propertyName,
String storage,
String folder,
DocumentProperty body)
PutSetProperty
Add/update document property.
|
FieldResponse |
PutUpdateField(String name,
String storage,
String folder,
String fieldName,
Field body)
PutUpdateField
Update field.
|
FieldsResponse |
PutUpdateFields(String name,
String storage,
String folder,
Fields body)
PutUpdateFields
Update fields.
|
void |
setBasePath(String basePath) |
public ApiInvoker getInvoker()
public void setBasePath(String basePath)
public String getBasePath()
public AnnotationResponse GetPageAnnotation(String name, Integer pageNumber, Integer annotationNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.annotationNumber
- Integer The annotation number.storage
- String The document storage.folder
- String The document folder.public AnnotationsResponse GetPageAnnotations(String name, Integer pageNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.public AttachmentResponse GetDocumentAttachmentByIndex(String name, Integer attachmentIndex, String storage, String folder)
name
- String The document name.attachmentIndex
- Integer The attachment index.storage
- String The document storage.folder
- String The document folder.public AttachmentsResponse GetDocumentAttachments(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public ResponseMessage GetDownloadDocumentAttachmentByIndex(String name, Integer attachmentIndex, String storage, String folder)
name
- String The document name.attachmentIndex
- Integer The attachment index.storage
- String The document storage.folder
- String The document folder.public BarcodeResponseList GetExtractBarcodes(String name, Integer pageNumber, Integer imageNumber, String storage, String folder)
name
- String Document name.pageNumber
- Integer Page number.imageNumber
- Integer Image number.storage
- String Document storage.folder
- String Document folder.public BookmarksResponse GetDocumentBookmarks(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public BookmarkResponse GetDocumentBookmarksChildren(String name, String bookmarkPath, String storage, String folder)
name
- String The document name.bookmarkPath
- String The bookmark path.storage
- String The document storage.folder
- String The document folder.public ResponseMessage GetDocument(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public ResponseMessage GetDocumentWithFormat(String name, String format, String storage, String folder, String outPath)
name
- String The document name.format
- String The format to convert.storage
- String The document storage.folder
- String The document folder.outPath
- String Path to save resultpublic SaaSposeResponse PostSignDocument(String name, String storage, String folder, Signature body)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.body
- Signature with signature data.public SplitResultResponse PostSplitDocument(String name, String format, Integer from, Integer to, String storage, String folder)
name
- String Document name.format
- String Resulting documents format.from
- Integer Start page if defined.to
- Integer End page if defined.storage
- String The document storage.folder
- String The document folder.public ResponseMessage PutConvertDocument(String format, String url, String outPath, File file)
format
- String The format to convert.url
- StringoutPath
- String Path to save resultfile
- Filepublic DocumentResponse PutCreateDocument(String name, String templateFile, String dataFile, String templateType, String storage, String folder)
name
- String The new document name.templateFile
- String The template file server path if defined.dataFile
- String The data file path (for xml template only).templateType
- String The template type, can be xml or html.storage
- String The document storage.folder
- String The new document folder.public DocumentResponse PostAppendDocument(String name, String appendFile, Integer startPage, Integer endPage, String storage, String folder, AppendDocument body)
name
- String The original document name.appendFile
- String Append file server path.startPage
- Integer Appending start page.endPage
- Integer Appending end page.storage
- String The documents storage.folder
- String The original document folder.body
- AppendDocument with the append document data.public DocumentResponse PutMergeDocuments(String name, String storage, String folder, MergeDocuments body)
name
- String Resulting documen name.storage
- String Resulting document storage.folder
- String Resulting document folder.body
- MergeDocuments with a list of documents.public SaaSposeResponse PutDocumentSaveAsTiff(String name, String resultFile, Float brightness, String compression, String colorDepth, Integer leftMargin, Integer rightMargin, Integer topMargin, Integer bottomMargin, String orientation, Boolean skipBlankPages, Integer width, Integer height, Integer xResolution, Integer yResolution, Integer pageIndex, Integer pageCount, String storage, String folder, TiffExportOptions body)
name
- String The document name.resultFile
- String The resulting file.brightness
- Float The image brightness.compression
- String Tiff compression. Possible values are: LZW, CCITT4, CCITT3, RLE, None.colorDepth
- String Image color depth. Possible valuse are: Default, Format8bpp, Format4bpp, Format1bpp.leftMargin
- Integer Left image margin.rightMargin
- Integer Right image margin.topMargin
- Integer Top image margin.bottomMargin
- Integer Bottom image margin.orientation
- String Image orientation. Possible values are: None, Landscape, Portait.skipBlankPages
- Boolean Skip blank pages flag.width
- Integer Image width.height
- Integer Image height.xResolution
- Integer Horizontal resolution.yResolution
- Integer Vertical resolution.pageIndex
- Integer Start page to export.pageCount
- Integer Number of pages to export.storage
- String The document storage.folder
- String The document folder.body
- TiffExportOptions with tiff export options.public FieldResponse GetField(String name, String fieldName, String storage, String folder)
name
- String The document name.fieldName
- String The field name/storage
- String The document storage.folder
- String The document folder.public FieldsResponse GetFields(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public SaaSposeResponse PostCreateField(String name, Integer page, String storage, String folder, Field body)
name
- String The document name.page
- Integer Document page number.storage
- String The document storage.folder
- String The document folder.body
- Field with the field data.public FieldResponse PutUpdateField(String name, String storage, String folder, String fieldName, Field body)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.fieldName
- Stringbody
- Field with the field data.public FieldsResponse PutUpdateFields(String name, String storage, String folder, Fields body)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.body
- Fields with the fields data.public TextItemsResponse GetFragment(String name, Integer pageNumber, Integer fragmentNumber, String withEmpty, String storage, String folder)
name
- StringpageNumber
- IntegerfragmentNumber
- IntegerwithEmpty
- Stringstorage
- Stringfolder
- Stringpublic TextItemsResponse GetFragments(String name, Integer pageNumber, String withEmpty, String storage, String folder)
name
- StringpageNumber
- IntegerwithEmpty
- Stringstorage
- Stringfolder
- Stringpublic TextFormatResponse GetFragmentTextFormat(String name, Integer pageNumber, Integer fragmentNumber, String storage, String folder)
name
- StringpageNumber
- IntegerfragmentNumber
- Integerstorage
- Stringfolder
- Stringpublic TextItemResponse GetSegment(String name, Integer pageNumber, Integer fragmentNumber, Integer segmentNumber, String storage, String folder)
name
- StringpageNumber
- IntegerfragmentNumber
- IntegersegmentNumber
- Integerstorage
- Stringfolder
- Stringpublic TextItemsResponse GetSegments(String name, Integer pageNumber, Integer fragmentNumber, String withEmpty, String storage, String folder)
name
- StringpageNumber
- IntegerfragmentNumber
- IntegerwithEmpty
- Stringstorage
- Stringfolder
- Stringpublic TextFormatResponse GetSegmentTextFormat(String name, Integer pageNumber, Integer fragmentNumber, Integer segmentNumber, String storage, String folder)
name
- StringpageNumber
- IntegerfragmentNumber
- IntegersegmentNumber
- Integerstorage
- Stringfolder
- Stringpublic ResponseMessage GetImage(String name, Integer pageNumber, Integer imageNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.imageNumber
- Integer The image format.storage
- String The document storage.folder
- String The document folder.public ImagesResponse GetImages(String name, Integer pageNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.public ResponseMessage GetImageWithFormat(String name, Integer pageNumber, Integer imageNumber, String format, Integer width, Integer height, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.imageNumber
- Integer The image format.format
- String Image format to convert, if not specified the common image data is read.width
- Integer The converted image width.height
- Integer The converted image height.storage
- String The document storage.folder
- String The document folder.public ImageResponse PostReplaceImage(String name, Integer pageNumber, Integer imageNumber, String imageFile, String storage, String folder, File file)
name
- String The document name.pageNumber
- Integer The page number.imageNumber
- Integer The image number.imageFile
- String Path to image file if specified. Request content is used otherwise.storage
- String The document storage.folder
- String The document folder.file
- Filepublic LinkAnnotationResponse GetPageLinkAnnotationByIndex(String name, Integer pageNumber, Integer linkIndex, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.linkIndex
- Integer The link index.storage
- String The document storage.folder
- String The document folder.public LinkAnnotationsResponse GetPageLinkAnnotations(String name, Integer pageNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.public SaaSposeResponse DeletePage(String name, Integer pageNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.public ResponseMessage GetPage(String name, Integer pageNumber, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.public DocumentPagesResponse GetPages(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public ResponseMessage GetPageWithFormat(String name, Integer pageNumber, String format, Integer width, Integer height, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.format
- String The format to convert if specified.width
- Integer The converted image width.height
- Integer The converted image height.storage
- String The document storage.folder
- String The document folder.public WordCountResponse GetWordsPerPage(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public SaaSposeResponse PostMovePage(String name, Integer pageNumber, Integer newIndex, String storage, String folder)
name
- String The document name.pageNumber
- Integer The page number.newIndex
- Integer The new page position/index.storage
- String The document storage.folder
- String The document folder.public SaaSposeResponse PostSignPage(String name, Integer pageNumber, String storage, String folder, Signature body)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.body
- Signature with the signature data.public DocumentPagesResponse PutAddNewPage(String name, String storage, String folder)
name
- String The document name.storage
- String The document storage.folder
- String The document folder.public SaaSposeResponse PutPageAddStamp(String name, Integer pageNumber, String storage, String folder, Stamp body)
name
- String The document name.pageNumber
- Integer The page number.storage
- String The document storage.folder
- String The document folder.body
- Stamp with data.public SaaSposeResponse DeleteProperties(String name, String storage, String folder)
name
- Stringstorage
- Stringfolder
- Stringpublic SaaSposeResponse DeleteProperty(String name, String propertyName, String storage, String folder)
name
- StringpropertyName
- Stringstorage
- Stringfolder
- Stringpublic DocumentPropertiesResponse GetDocumentProperties(String name, String storage, String folder)
name
- Stringstorage
- Stringfolder
- Stringpublic DocumentPropertyResponse GetDocumentProperty(String name, String propertyName, String storage, String folder)
name
- StringpropertyName
- Stringstorage
- Stringfolder
- Stringpublic DocumentPropertyResponse PutSetProperty(String name, String propertyName, String storage, String folder, DocumentProperty body)
name
- StringpropertyName
- Stringstorage
- Stringfolder
- Stringbody
- DocumentPropertypublic TextItemsResponse GetPageTextItems(String name, Integer pageNumber, String withEmpty, String storage, String folder)
name
- StringpageNumber
- IntegerwithEmpty
- Stringstorage
- Stringfolder
- Stringpublic TextItemsResponse GetTextItems(String name, String withEmpty, String storage, String folder)
name
- StringwithEmpty
- Stringstorage
- Stringfolder
- Stringpublic DocumentTextReplaceResponse PostDocumentReplaceText(String name, String storage, String folder, TextReplace body)
name
- Stringstorage
- Stringfolder
- Stringbody
- TextReplacepublic DocumentTextReplaceResponse PostDocumentReplaceTextList(String name, String storage, String folder, TextReplaceListRequest body)
name
- Stringstorage
- Stringfolder
- Stringbody
- TextReplaceListRequestpublic PageTextReplaceResponse PostPageReplaceText(String name, Integer pageNumber, String storage, String folder, TextReplace body)
name
- StringpageNumber
- Integerstorage
- Stringfolder
- Stringbody
- TextReplacepublic PageTextReplaceResponse PostPageReplaceTextList(String name, Integer pageNumber, String storage, String folder, TextReplaceListRequest body)
name
- StringpageNumber
- Integerstorage
- Stringfolder
- Stringbody
- TextReplaceListRequestCopyright © 2016. All rights reserved.