asposehtmlcloud.api package¶
Submodules¶
asposehtmlcloud.api.html_api module¶
-
class
asposehtmlcloud.api.html_api.
HtmlApi
(config=None)[source]¶ Bases:
object
-
GetConvertDocumentToImage
(name, out_format, **kwargs)¶ Convert the HTML, EPUB, SVG documents from the storage by its name to the specified image format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name (html, epub, svg formats). (required)
out_format (str) – Resulting image format (jpeg, png, bmp, tiff, gif). (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
resolution (int) – Resolution of resulting image.
folder (str) – The source document folder.
storage (str) – The source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToImageByUrl
(source_url, out_format, **kwargs)¶ Convert the HTML page from the web by its URL to the specified image format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
out_format (str) – Resulting image format(jpeg, png, bmp, tiff, gif). (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
resolution (int) – Resolution of resulting image.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToMarkdown
(name, **kwargs)¶ Converts the HTML document (located on storage) to Markdown and returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
folder (str) – Source document folder.
storage (str) – Source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToMhtmlByUrl
(source_url, **kwargs)¶ Converts the HTML page from Web by its URL to MHTML returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToPdf
(name, **kwargs)¶ Convert the HTML, EPUB, SVG document from the storage by its name to PDF.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToPdfByUrl
(source_url, **kwargs)¶ Convert the HTML page from the web by its URL to PDF.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToXps
(name, **kwargs)¶ Convert the HTML, EPUB, SVG document from the storage by its name to XPS.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertDocumentToXpsByUrl
(source_url, **kwargs)¶ Convert the HTML page from the web by its URL to XPS.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetConvertMarkdownToHtml
(name, **kwargs)¶ Converts the Markdown document (located on storage) to HTML and returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
folder (str) – Source document folder.
storage (str) – Source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentByUrl
(source_url, **kwargs)¶ Return all HTML page with linked resources packaged as a ZIP archive by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentFragmentByCssSelector
(name, selector, out_format, **kwargs)¶ Return list of HTML fragments matching the specified CSS selector.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root or html file.
selector (str) – CSS selector string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentFragmentByCssSelectorByUrl
(source_url, selector, out_format, **kwargs)¶ Return list of HTML fragments matching the specified CSS selector by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
selector (str) – CSS selector string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentFragmentByXPath
(name, x_path, out_format, **kwargs)¶ Return list of HTML fragments matching the specified XPath query.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root or html file.
x_path (str) – XPath query string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
storage (str) – The document storage.
folder (str) – The document folder.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentFragmentByXPathByUrl
(source_url, x_path, out_format, **kwargs)¶ Return list of HTML fragments matching the specified XPath query by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
x_path (str) – XPath query string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentImages
(name, **kwargs)¶ Return all HTML document images packaged as a ZIP archive.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetDocumentImagesByUrl
(source_url, **kwargs)¶ Return all HTML page images packaged as a ZIP archive by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetHtmlWarning
(url, **kwargs)¶ Checks the markup validity of Web documents in HTML, XHTML, etc., and return result in json format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetMergeHtmlTemplate
(template_name, data_path, **kwargs)¶ Populate HTML document template with data located as a file in the storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
template_name (str) – Template document name. Template document is HTML or zipped HTML. (required)
data_path (str) – Data source file path in the storage. Supported data format: XML (required)
options (str) – Template merge options: reserved for further implementation.
folder (str) – The template document folder.
storage (str) – The template document and data source storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
GetSeoWarning
(addr, **kwargs)¶ Page analysis and return of SEO warnings in json format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
addr (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PostConvertDocumentInRequestToImage
(out_path, out_format, file, **kwargs)¶ Converts the HTML, EPUB, SVG document (in request content) to the specified image format and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.jpg) (required)
out_format (str) – (jpeg, png, bmp, tiff, gif)(required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
resolution (int) – Resolution of resulting image. Default is 96 dpi.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PostConvertDocumentInRequestToMarkdown
(out_path, file, **kwargs)¶ Converts the HTML document (in request content) to Markdown and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.md) (required)
file (file) – A file to be converted. (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PostConvertDocumentInRequestToPdf
(out_path, file, **kwargs)¶ Converts the HTML, EPUB, SVG document (in request content) to PDF and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.pdf) (required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PostConvertDocumentInRequestToXps
(out_path, file, **kwargs)¶ Converts the HTML, EPUB, SVG document (in request content) to XPS and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.xps) (required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PostConvertMarkdownInRequestToHtml
(out_path, file, **kwargs)¶ Converts the Markdown document (in request content) to HTML and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.html) (required)
file (file) – A file to be converted. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PostMergeHtmlTemplate
(template_name, out_path, file, **kwargs)¶ Populate HTML document template with data from the request body. Result document will be saved to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
template_name (str) – Template document name. Template document is HTML or zipped HTML. (required)
out_path (str) – Result document path. (required)
file (file) – A data file to populate template. (required)
options (str) – Template merge options: reserved for further implementation.
folder (str) – The template document folder.
storage (str) – The template document and data source storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PutConvertDocumentToImage
(name, out_path, out_format, **kwargs)¶ Converts the HTML, EPUB, SVG document (located on storage) to the specified image format and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.jpg) (required)
out_format (str) – (jpeg, png, bmp, tiff, gif)(required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
resolution (int) – Resolution of resulting image. Default is 96 dpi.
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PutConvertDocumentToMarkdown
(name, out_path, **kwargs)¶ Converts the HTML document (located on storage) to Markdown and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.md) (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PutConvertDocumentToPdf
(name, out_path, **kwargs)¶ Converts the HTML, EPUB, SVG document (located on storage) to PDF and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.pdf) (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PutConvertDocumentToXps
(name, out_path, **kwargs)¶ Converts the HTML, EPUB, SVG document (located on storage) to XPS and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.xps) (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
PutConvertMarkdownToHtml
(name, out_path, **kwargs)¶ Converts the Markdown document (located on storage) to HTML and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.html) (required)
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToImage
(name, out_format, **kwargs)¶ Convert the HTML, EPUB, SVG documents from the storage by its name to the specified image format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name (html, epub, svg formats). (required)
out_format (str) – Resulting image format (jpeg, png, bmp, tiff, gif). (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
resolution (int) – Resolution of resulting image.
folder (str) – The source document folder.
storage (str) – The source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToImageByUrl
(source_url, out_format, **kwargs)¶ Convert the HTML page from the web by its URL to the specified image format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
out_format (str) – Resulting image format(jpeg, png, bmp, tiff, gif). (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
resolution (int) – Resolution of resulting image.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToMarkdown
(name, **kwargs)¶ Converts the HTML document (located on storage) to Markdown and returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
folder (str) – Source document folder.
storage (str) – Source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToMhtmlByUrl
(source_url, **kwargs)¶ Converts the HTML page from Web by its URL to MHTML returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToPdf
(name, **kwargs)¶ Convert the HTML, EPUB, SVG document from the storage by its name to PDF.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToPdfByUrl
(source_url, **kwargs)¶ Convert the HTML page from the web by its URL to PDF.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToXps
(name, **kwargs)¶ Convert the HTML, EPUB, SVG document from the storage by its name to XPS.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertDocumentToXpsByUrl
(source_url, **kwargs)¶ Convert the HTML page from the web by its URL to XPS.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getConvertMarkdownToHtml
(name, **kwargs)¶ Converts the Markdown document (located on storage) to HTML and returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
folder (str) – Source document folder.
storage (str) – Source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentByUrl
(source_url, **kwargs)¶ Return all HTML page with linked resources packaged as a ZIP archive by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentFragmentByCssSelector
(name, selector, out_format, **kwargs)¶ Return list of HTML fragments matching the specified CSS selector.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root or html file.
selector (str) – CSS selector string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentFragmentByCssSelectorByUrl
(source_url, selector, out_format, **kwargs)¶ Return list of HTML fragments matching the specified CSS selector by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
selector (str) – CSS selector string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentFragmentByXPath
(name, x_path, out_format, **kwargs)¶ Return list of HTML fragments matching the specified XPath query.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root or html file.
x_path (str) – XPath query string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
storage (str) – The document storage.
folder (str) – The document folder.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentFragmentByXPathByUrl
(source_url, x_path, out_format, **kwargs)¶ Return list of HTML fragments matching the specified XPath query by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
x_path (str) – XPath query string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentImages
(name, **kwargs)¶ Return all HTML document images packaged as a ZIP archive.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getDocumentImagesByUrl
(source_url, **kwargs)¶ Return all HTML page images packaged as a ZIP archive by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getHtmlWarning
(url, **kwargs)¶ Checks the markup validity of Web documents in HTML, XHTML, etc., and return result in json format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getMergeHtmlTemplate
(template_name, data_path, **kwargs)¶ Populate HTML document template with data located as a file in the storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
template_name (str) – Template document name. Template document is HTML or zipped HTML. (required)
data_path (str) – Data source file path in the storage. Supported data format: XML (required)
options (str) – Template merge options: reserved for further implementation.
folder (str) – The template document folder.
storage (str) – The template document and data source storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
getSeoWarning
(addr, **kwargs)¶ Page analysis and return of SEO warnings in json format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
addr (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_image
(name, out_format, **kwargs)[source]¶ Convert the HTML, EPUB, SVG documents from the storage by its name to the specified image format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name (html, epub, svg formats). (required)
out_format (str) – Resulting image format (jpeg, png, bmp, tiff, gif). (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
resolution (int) – Resolution of resulting image.
folder (str) – The source document folder.
storage (str) – The source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_image_by_url
(source_url, out_format, **kwargs)[source]¶ Convert the HTML page from the web by its URL to the specified image format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
out_format (str) – Resulting image format(jpeg, png, bmp, tiff, gif). (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
resolution (int) – Resolution of resulting image.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_markdown
(name, **kwargs)[source]¶ Converts the HTML document (located on storage) to Markdown and returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
folder (str) – Source document folder.
storage (str) – Source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_mhtml_by_url
(source_url, **kwargs)[source]¶ Converts the HTML page from Web by its URL to MHTML returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_pdf
(name, **kwargs)[source]¶ Convert the HTML, EPUB, SVG document from the storage by its name to PDF.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_pdf_by_url
(source_url, **kwargs)[source]¶ Convert the HTML page from the web by its URL to PDF.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_xps
(name, **kwargs)[source]¶ Convert the HTML, EPUB, SVG document from the storage by its name to XPS.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_document_to_xps_by_url
(source_url, **kwargs)[source]¶ Convert the HTML page from the web by its URL to XPS.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
width (int) – Resulting image width.
height (int) – Resulting image height.
left_margin (int) – Left resulting image margin.
right_margin (int) – Right resulting image margin.
top_margin (int) – Top resulting image margin.
bottom_margin (int) – Bottom resulting image margin.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_convert_markdown_to_html
(name, **kwargs)[source]¶ Converts the Markdown document (located on storage) to HTML and returns resulting file in response content.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
folder (str) – Source document folder.
storage (str) – Source document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_by_url
(source_url, **kwargs)[source]¶ Return all HTML page with linked resources packaged as a ZIP archive by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_fragment_by_x_path
(name, x_path, out_format, **kwargs)[source]¶ Return list of HTML fragments matching the specified XPath query.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root or html file.
x_path (str) – XPath query string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
storage (str) – The document storage.
folder (str) – The document folder.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_fragment_by_x_path_by_url
(source_url, x_path, out_format, **kwargs)[source]¶ Return list of HTML fragments matching the specified XPath query by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
x_path (str) – XPath query string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_fragments_by_css_selector
(name, selector, out_format, **kwargs)[source]¶ Return list of HTML fragments matching the specified CSS selector.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root or html file.
selector (str) – CSS selector string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_fragments_by_css_selector_by_url
(source_url, selector, out_format, **kwargs)[source]¶ Return list of HTML fragments matching the specified CSS selector by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
selector (str) – CSS selector string. (required)
out_format (str) – Output format. Possible values: ‘plain’ and ‘json’. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_images
(name, **kwargs)[source]¶ Return all HTML document images packaged as a ZIP archive.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – The document name (required). Presented as zip archive with one html file in the root.
folder (str) – The document folder.
storage (str) – The document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_document_images_by_url
(source_url, **kwargs)[source]¶ Return all HTML page images packaged as a ZIP archive by the source page URL.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
source_url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_html_warning
(url, **kwargs)[source]¶ Checks the markup validity of Web documents in HTML, XHTML, etc., and return result in json format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
url (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_merge_html_template
(template_name, data_path, **kwargs)[source]¶ Populate HTML document template with data located as a file in the storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
template_name (str) – Template document name. Template document is HTML or zipped HTML. (required)
data_path (str) – Data source file path in the storage. Supported data format: XML (required)
options (str) – Template merge options: reserved for further implementation.
folder (str) – The template document folder.
storage (str) – The template document and data source storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
get_seo_warning
(addr, **kwargs)[source]¶ Page analysis and return of SEO warnings in json format.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
addr (str) – Source page URL. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
postConvertDocumentInRequestToImage
(out_path, out_format, file, **kwargs)¶ Converts the HTML, EPUB, SVG document (in request content) to the specified image format and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.jpg) (required)
out_format (str) – (jpeg, png, bmp, tiff, gif)(required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
resolution (int) – Resolution of resulting image. Default is 96 dpi.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
postConvertDocumentInRequestToMarkdown
(out_path, file, **kwargs)¶ Converts the HTML document (in request content) to Markdown and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.md) (required)
file (file) – A file to be converted. (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
postConvertDocumentInRequestToPdf
(out_path, file, **kwargs)¶ Converts the HTML, EPUB, SVG document (in request content) to PDF and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.pdf) (required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
postConvertDocumentInRequestToXps
(out_path, file, **kwargs)¶ Converts the HTML, EPUB, SVG document (in request content) to XPS and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.xps) (required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
postConvertMarkdownInRequestToHtml
(out_path, file, **kwargs)¶ Converts the Markdown document (in request content) to HTML and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.html) (required)
file (file) – A file to be converted. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
postMergeHtmlTemplate
(template_name, out_path, file, **kwargs)¶ Populate HTML document template with data from the request body. Result document will be saved to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
template_name (str) – Template document name. Template document is HTML or zipped HTML. (required)
out_path (str) – Result document path. (required)
file (file) – A data file to populate template. (required)
options (str) – Template merge options: reserved for further implementation.
folder (str) – The template document folder.
storage (str) – The template document and data source storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
post_convert_document_in_request_to_image
(out_path, out_format, file, **kwargs)[source]¶ Converts the HTML, EPUB, SVG document (in request content) to the specified image format and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.jpg) (required)
out_format (str) – (jpeg, png, bmp, tiff, gif)(required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
resolution (int) – Resolution of resulting image. Default is 96 dpi.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
post_convert_document_in_request_to_markdown
(out_path, file, **kwargs)[source]¶ Converts the HTML document (in request content) to Markdown and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.md) (required)
file (file) – A file to be converted. (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
post_convert_document_in_request_to_pdf
(out_path, file, **kwargs)[source]¶ Converts the HTML, EPUB, SVG document (in request content) to PDF and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.pdf) (required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
post_convert_document_in_request_to_xps
(out_path, file, **kwargs)[source]¶ Converts the HTML, EPUB, SVG document (in request content) to XPS and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.xps) (required)
file (file) – A file to be converted. (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
- Returns
File. If the method is called asynchronously, returns the request thread.
-
post_convert_markdown_in_request_to_html
(out_path, file, **kwargs)[source]¶ Converts the Markdown document (in request content) to HTML and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.html) (required)
file (file) – A file to be converted. (required)
- Returns
File. If the method is called asynchronously, returns the request thread.
-
post_merge_html_template
(template_name, out_path, file, **kwargs)[source]¶ Populate HTML document template with data from the request body. Result document will be saved to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
template_name (str) – Template document name. Template document is HTML or zipped HTML. (required)
out_path (str) – Result document path. (required)
file (file) – A data file to populate template. (required)
options (str) – Template merge options: reserved for further implementation.
folder (str) – The template document folder.
storage (str) – The template document and data source storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
putConvertDocumentToImage
(name, out_path, out_format, **kwargs)¶ Converts the HTML, EPUB, SVG document (located on storage) to the specified image format and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.jpg) (required)
out_format (str) – (jpeg, png, bmp, tiff, gif)(required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
resolution (int) – Resolution of resulting image. Default is 96 dpi.
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
putConvertDocumentToMarkdown
(name, out_path, **kwargs)¶ Converts the HTML document (located on storage) to Markdown and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.md) (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
putConvertDocumentToPdf
(name, out_path, **kwargs)¶ Converts the HTML, EPUB, SVG document (located on storage) to PDF and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.pdf) (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
putConvertDocumentToXps
(name, out_path, **kwargs)¶ Converts the HTML, EPUB, SVG document (located on storage) to XPS and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.xps) (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
putConvertMarkdownToHtml
(name, out_path, **kwargs)¶ Converts the Markdown document (located on storage) to HTML and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.html) (required)
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
put_convert_document_to_image
(name, out_path, out_format, **kwargs)[source]¶ Converts the HTML, EPUB, SVG document (located on storage) to the specified image format and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.jpg) (required)
out_format (str) – (jpeg, png, bmp, tiff, gif)(required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
resolution (int) – Resolution of resulting image. Default is 96 dpi.
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
put_convert_document_to_markdown
(name, out_path, **kwargs)[source]¶ Converts the HTML document (located on storage) to Markdown and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.md) (required)
use_git (str) – Use Git Markdown flavor to save (“true” or “false”).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
put_convert_document_to_pdf
(name, out_path, **kwargs)[source]¶ Converts the HTML, EPUB, SVG document (located on storage) to PDF and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.pdf) (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
put_convert_document_to_xps
(name, out_path, **kwargs)[source]¶ Converts the HTML, EPUB, SVG document (located on storage) to XPS and uploads resulting file to storage.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting filename (ex. /folder1/folder2/result.xps) (required)
width (int) – Resulting document page width in points (1/96 inch).
height (int) – Resulting document page height in points (1/96 inch).
left_margin (int) – Left resulting document page margin in points (1/96 inch).
right_margin (int) – Right resulting document page margin in points (1/96 inch).
top_margin (int) – Top resulting document page margin in points (1/96 inch).
bottom_margin (int) – Bottom resulting document page margin in points (1/96 inch).
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
put_convert_markdown_to_html
(name, out_path, **kwargs)[source]¶ Converts the Markdown document (located on storage) to HTML and uploads resulting file to storage by specified path.
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
name (str) – Document name. (required)
out_path (str) – Full resulting file path in the storage (ex. /folder1/folder2/result.html) (required)
folder (str) – The source document folder.
storage (str) – The source and resulting document storage.
- Returns
File. If the method is called asynchronously, returns the request thread.
-
asposehtmlcloud.api.storage_api module¶
-
class
asposehtmlcloud.api.storage_api.
StorageApi
(config=None)[source]¶ Bases:
object
-
CopyFile
(src_path, dest_path, **kwargs)¶ Copy file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source file path e.g. ‘/folder/file.ext’ (required)
dest_path (str) – Destination file path (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
version_id (str) – File version ID to copy
- Returns
None. If the method is called asynchronously, returns the request thread.
-
CopyFolder
(src_path, dest_path, **kwargs)¶ Copy folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source folder path e.g. ‘/src’ (required)
dest_path (str) – Destination folder path e.g. ‘/dst’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
CreateFolder
(path, **kwargs)¶ Create the folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path to create e.g. ‘folder_1/folder_2/’ (required)
storage_name (str) – Storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
DeleteFile
(path, **kwargs)¶ Delete file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/folder/file.ext’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID to delete
- Returns
None. If the method is called asynchronously, returns the request thread.
-
DeleteFolder
(path, **kwargs)¶ Delete folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path e.g. ‘/folder’ (required)
storage_name (str) – Storage name
recursive (bool) – Enable to delete folders, subfolders and files
- Returns
None. If the method is called asynchronously, returns the request thread.
-
DownloadFile
(path, **kwargs)¶ Download file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/folder/file.ext’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID to download
- Returns
file. If the method is called asynchronously, returns the request thread.
-
GetDiscUsage
(**kwargs)¶ Get disc usage
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
storage_name (str) – Storage name
- Returns
DiscUsage. If the method is called asynchronously, returns the request thread.
-
GetFileList
(path, **kwargs)¶ Get all files and folders within a folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path e.g. ‘/folder’ (required)
storage_name (str) – Storage name
- Returns
FilesList. If the method is called asynchronously, returns the request thread.
-
GetFileVersions
(path, **kwargs)¶ Get file versions
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/file.ext’ (required)
storage_name (str) – Storage name
- Returns
FileVersions. If the method is called asynchronously, returns the request thread.
-
MoveFile
(src_path, dest_path, **kwargs)¶ Move file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source file path e.g. ‘/src.ext’ (required)
dest_path (str) – Destination file path e.g. ‘/dest.ext’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
version_id (str) – File version ID to move
- Returns
None. If the method is called asynchronously, returns the request thread.
-
MoveFolder
(src_path, dest_path, **kwargs)¶ Move folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Folder path to move e.g. ‘/folder’ (required)
dest_path (str) – Destination folder path to move to e.g ‘/dst’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
ObjectExists
(path, **kwargs)¶ Check if file or folder exists
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File or folder path e.g. ‘/file.ext’ or ‘/folder’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID
- Returns
ObjectExist. If the method is called asynchronously, returns the request thread.
-
StorageExists
(storage_name, **kwargs)¶ Check if storage exists
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
storage_name (str) – Storage name (required)
- Returns
StorageExist. If the method is called asynchronously, returns the request thread.
-
UploadFile
(path, file, **kwargs)¶ Upload file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. (required)
file (file) – File to upload (required)
storage_name (str) – Storage name
- Returns
FilesUploadResult. If the method is called asynchronously, returns the request thread.
-
copyFile
(src_path, dest_path, **kwargs)¶ Copy file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source file path e.g. ‘/folder/file.ext’ (required)
dest_path (str) – Destination file path (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
version_id (str) – File version ID to copy
- Returns
None. If the method is called asynchronously, returns the request thread.
-
copyFolder
(src_path, dest_path, **kwargs)¶ Copy folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source folder path e.g. ‘/src’ (required)
dest_path (str) – Destination folder path e.g. ‘/dst’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
copy_file
(src_path, dest_path, **kwargs)[source]¶ Copy file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source file path e.g. ‘/folder/file.ext’ (required)
dest_path (str) – Destination file path (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
version_id (str) – File version ID to copy
- Returns
None. If the method is called asynchronously, returns the request thread.
-
copy_folder
(src_path, dest_path, **kwargs)[source]¶ Copy folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source folder path e.g. ‘/src’ (required)
dest_path (str) – Destination folder path e.g. ‘/dst’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
createFolder
(path, **kwargs)¶ Create the folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path to create e.g. ‘folder_1/folder_2/’ (required)
storage_name (str) – Storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
create_folder
(path, **kwargs)[source]¶ Create the folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path to create e.g. ‘folder_1/folder_2/’ (required)
storage_name (str) – Storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
deleteFile
(path, **kwargs)¶ Delete file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/folder/file.ext’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID to delete
- Returns
None. If the method is called asynchronously, returns the request thread.
-
deleteFolder
(path, **kwargs)¶ Delete folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path e.g. ‘/folder’ (required)
storage_name (str) – Storage name
recursive (bool) – Enable to delete folders, subfolders and files
- Returns
None. If the method is called asynchronously, returns the request thread.
-
delete_file
(path, **kwargs)[source]¶ Delete file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/folder/file.ext’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID to delete
- Returns
None. If the method is called asynchronously, returns the request thread.
-
delete_folder
(path, **kwargs)[source]¶ Delete folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path e.g. ‘/folder’ (required)
storage_name (str) – Storage name
recursive (bool) – Enable to delete folders, subfolders and files
- Returns
None. If the method is called asynchronously, returns the request thread.
-
downloadFile
(path, **kwargs)¶ Download file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/folder/file.ext’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID to download
- Returns
file. If the method is called asynchronously, returns the request thread.
-
download_file
(path, **kwargs)[source]¶ Download file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/folder/file.ext’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID to download
- Returns
file. If the method is called asynchronously, returns the request thread.
-
getDiscUsage
(**kwargs)¶ Get disc usage
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
storage_name (str) – Storage name
- Returns
DiscUsage. If the method is called asynchronously, returns the request thread.
-
getFileList
(path, **kwargs)¶ Get all files and folders within a folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path e.g. ‘/folder’ (required)
storage_name (str) – Storage name
- Returns
FilesList. If the method is called asynchronously, returns the request thread.
-
getFileVersions
(path, **kwargs)¶ Get file versions
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/file.ext’ (required)
storage_name (str) – Storage name
- Returns
FileVersions. If the method is called asynchronously, returns the request thread.
-
get_disc_usage
(**kwargs)[source]¶ Get disc usage
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
storage_name (str) – Storage name
- Returns
DiscUsage. If the method is called asynchronously, returns the request thread.
-
get_file_versions
(path, **kwargs)[source]¶ Get file versions
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File path e.g. ‘/file.ext’ (required)
storage_name (str) – Storage name
- Returns
FileVersions. If the method is called asynchronously, returns the request thread.
-
get_files_list
(path, **kwargs)[source]¶ Get all files and folders within a folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Folder path e.g. ‘/folder’ (required)
storage_name (str) – Storage name
- Returns
FilesList. If the method is called asynchronously, returns the request thread.
-
moveFile
(src_path, dest_path, **kwargs)¶ Move file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source file path e.g. ‘/src.ext’ (required)
dest_path (str) – Destination file path e.g. ‘/dest.ext’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
version_id (str) – File version ID to move
- Returns
None. If the method is called asynchronously, returns the request thread.
-
moveFolder
(src_path, dest_path, **kwargs)¶ Move folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Folder path to move e.g. ‘/folder’ (required)
dest_path (str) – Destination folder path to move to e.g ‘/dst’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
move_file
(src_path, dest_path, **kwargs)[source]¶ Move file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Source file path e.g. ‘/src.ext’ (required)
dest_path (str) – Destination file path e.g. ‘/dest.ext’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
version_id (str) – File version ID to move
- Returns
None. If the method is called asynchronously, returns the request thread.
-
move_folder
(src_path, dest_path, **kwargs)[source]¶ Move folder
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
src_path (str) – Folder path to move e.g. ‘/folder’ (required)
dest_path (str) – Destination folder path to move to e.g ‘/dst’ (required)
src_storage_name (str) – Source storage name
dest_storage_name (str) – Destination storage name
- Returns
None. If the method is called asynchronously, returns the request thread.
-
objectExists
(path, **kwargs)¶ Check if file or folder exists
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File or folder path e.g. ‘/file.ext’ or ‘/folder’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID
- Returns
ObjectExist. If the method is called asynchronously, returns the request thread.
-
object_exists
(path, **kwargs)[source]¶ Check if file or folder exists
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – File or folder path e.g. ‘/file.ext’ or ‘/folder’ (required)
storage_name (str) – Storage name
version_id (str) – File version ID
- Returns
ObjectExist. If the method is called asynchronously, returns the request thread.
-
storageExists
(storage_name, **kwargs)¶ Check if storage exists
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
storage_name (str) – Storage name (required)
- Returns
StorageExist. If the method is called asynchronously, returns the request thread.
-
storage_exists
(storage_name, **kwargs)[source]¶ Check if storage exists
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
storage_name (str) – Storage name (required)
- Returns
StorageExist. If the method is called asynchronously, returns the request thread.
-
uploadFile
(path, file, **kwargs)¶ Upload file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. (required)
file (file) – File to upload (required)
storage_name (str) – Storage name
- Returns
FilesUploadResult. If the method is called asynchronously, returns the request thread.
-
upload_file
(path, file, **kwargs)[source]¶ Upload file
This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
- Parameters
async_req (bool) – Asynchronous request
path (str) – Path where to upload including filename and extension e.g. /file.ext or /Folder 1/file.ext If the content is multipart and path does not contains the file name it tries to get them from filename parameter from Content-Disposition header. (required)
file (file) – File to upload (required)
storage_name (str) – Storage name
- Returns
FilesUploadResult. If the method is called asynchronously, returns the request thread.
-


Audio Files in HTML
Your browser doesn't support audio files
Video Files in HTML
Your browser doesn't support the latest web standards
Everything else
Fallback text in case your browser doesn't support this


{% extends "layout_list.html" %} {% set active_page = "probegenerator" %} {% block title %}Probe Generators{% endblock %} {% block topsummary %} {% set obj_singular = True if objects.count() == 1 else False %}
Probe Generators are nodes which listen for requests from the AMPT Manager to send probe packets to monitored network segments. One or more generators must be deployed and activated to configure monitoring for network segments.
There is already a default probe generator configured for the local host. To use it, deploy the ampt-generator package on the AMPT Manager and activate it below.
There {{ 'is' if obj_singular else 'are' }} currently {% if objects %}{{ objects|length }}{% else %}no{% endif %} probe generator{% if not obj_singular %}s{% endif %}.
{% endblock %} {% block thead_content %}No probe generators exist yet.
{% endblock %}


Select multiple files of varying sizes to compute MD5 sum of, in pool of webworkers:
ℹ large files (>10MB) gives the best results otherwise the timing starts to be dominated by the UI updates rather than the computation of hashes


Snookes1516.github.io
Your resume might be perfect but without a proper cover letter you may not get that coveted interview. L R Cover Letter Examples 1 Letter Resume.
Cover Letter Template - My Easy Resume. How to Write a Cover Letter That Gets You an Interview. Taking the time to work on your cover letter is important. This page offers some tips advice on how to make your cover letter Q: I’m actively searching for a job in another state. How can I mention in my resume and cover letter that I’m open to relocation without getting overlooked?. Investment Banking Cover Letter Template: Copy and Paste This Template to Land Investment Banking Interviews and Offers.
Tips for Writing a Standout Cover Letter. Your goal when writing a cover letter is to attract interest and get employers to read your resume. These. Cover Letters For Dummies Cheat Sheet - dummies. The difference between a cover letter and - Resume Writers. Receptionist Cover Letter Sample.
It's hard finding the perfect investment banking cover letter template. Copy the steps here and get a cover letter that gets real results. How To Write A Cover Letter Youth Central. How to Write a Cover Letter. Cover letters. As much as they require more work, cover letters are a great opportunity to cover qualifications we can't fully explain. 5 Ways to Write a Cover Letter - wikiHow. What Color Is Your Parachute? Guide to Rethinking Resumes: Write a Winning Resume and Cover Letter and Land Your Dream Interview Richard N. Bolles on Amazon.com. What Color Is Your Parachute? Guide to Rethinking Resumes. Page 1 of 1: Cover letter example for a Teaching Assistant position. Amend as suitable and start using them for your job applications. A teaching assistant Graphic Design Cover Letter Samples - Craig Kunce. These cover letter examples written by a professional resume writing firm will inspire your own cover letter writing for all job search situations.
Cover Letter Examples and Writing Tips Distinctive Documents. 02.10.14; work smart; The 7 Secrets To An Eye-Catching, Gig-Nabbing Cover Letter Hiring managers are trying to find a needle in an application haystack. Need a great cover letter to match your executive resume? Download our free executive cover letter example - begin improving your cover letter today.
Executive resume writing services by award-winning executive resume writer Laura Smith-Proulx. Former recruiter. Writing a cover letter is tough, but it doesn’t have to be. Our 100% Free Cover Letter Templates lay the groundwork and let you customize by style and industry. How to Write a Cover Letter The Ultimate Guide. Looking to write your cabin crew cover letter? You can now download our pre-written motivation letters tailored for the flight attendant. Muse's head of HR explains the common mistakes she sees on résumé, and when you should include a cover letter. If you want to know what the difference between a cover letter and a letter of interest is, read our detailed guide to learn more how to use them to find a better.
Muse's Toni Thompson shares a few résumé and cover letter. Your cover letter is one of the most important pieces of your job application packet. Be sure to inject some of your sparkling personality into the conversation. Use this Receptionist Cover Letter sample to help you write a powerful cover letter that will separate you from the competition.
Cold Calling Cover Letter Youth Central. Take the initiative and contact employers with these resourceful cold calling cover letter examples from Youth Central. Executive Resume Writing Service Best Resume Writer. This article explains you how to write a Cover Letter for Resume. A Sample cover letter with the Cover Letter Format has been provided. Do you need to revise your cover letter? John Moore/Getty Images Cover letters can be a pain. You've essentially got to write.
Discussing Relocation in Your Resume Cover Letter. Letter Resume Cover Letter Examples 1 As well as everyone knew about a resume. Resume is the standard format of a letter that for apply 750+ Cover Letter Templates MyPerfectCoverLetter. Executive Cover Letter Samples - Resume Genius. A cover letter shouldn’t be a synopsis of your resume. Instead, use it to tell the tale of why your experience, education, and skills make you the right candidate. The 7 Secrets To An Eye-Catching, Gig-Nabbing Cover Letter. Mistakes that will ruin your cover letter - Business Insider. 5 Cabin Crew Cover Letter Samples (Step-By-Step Writing Guide). Amazing Cover Letters - Cover Letter and Job Application. Cover Letter for a Teaching Assistant in Cover Letters. Instant cover letter, covering letters and application letters for your job search and resume. Guaranteed job interviews.
Doing a cover letter for resume.
Sample Cover Letters In Response to Ad / Job Application. Learn how to write a convincing cover letter that will impress a hiring manager. A well-written cover letter will land you more interviews, guaranteed.
Downloadable Cover Letter Examples - Resume Companion. I appreciate your time going through my resume and I hope I can better demonstrate my abilities and readiness in a job interview. Cover Letter for Resume with Sample Cover Letter Format.
Cover Letter Template Here is a fill in the blank cover letter template from my-easy-resume.com that should give you a leg up on the competition. Investment Banking Cover Letter Template Tutorial.


LETTERS TO THE EDITOR: Just more of the same
by THE WASHINGTON TIMESANALYSIS/OPINION:
As the 2020 election approaches, the cold war started by the Democrats two years ago has been ramped up to prevent the re-election of President Trump. The “whistleblower” report is essentially just a continuation of the second Steele opposition-research dossier.
Democrats who advanced the Russia-collusion hoax and Mueller report are now continuing their impeachment drive with the whistleblower allegations written by Democratic congressional staffers and former Obama administration members. Mr. Trump is right to ask Rep. Adam Schiff of the House Intelligence Committee to resign after Mr. Schiff created lies from the transcript of Mr. Trump’s conversation with the president of Ukraine. Mr. Schiff continues to use the same allegations, which he presented for three years with the supporting liberal media. The allegations were then disproven, and like the media reports, were shown to be bogus.
LT. COL. DOMINIK GEORGE NARGELE
U.S. Marine Corps (retired)
Arlington, Va.
Sign up for Daily Opinion Newsletter
Copyright © 2019 The Washington Times, LLC. Click here for reprint permission.
Please read our comment policy before commenting.


KBO as Linked Open Data
KBO
The Crossroads Bank for Enterprises (BCE/KBO) is a register containing comprehensive identification data related to businesses and their ‘establishment units’ (i.e. business locations). It includes data from the national register of legal entities, the trade register and VAT and NSSO information. More info: KBO
KBO as Open Data
Starting from May 9th 2014, the KBO data will become available as Open Data: data which can be freely reused.
KBO as Linked Open Data
This site aims to be a showcase how Open Data can be published according to the Linked Open Data publishing principles and best practices.


super.tearDown()
method that are not performed inside a finally
block.
If an exception is thrown before super.tearDown()
is called it could lead to inconsistencies and leaks.
Example:
public class AnotherTest extends CompanyTestCase {
private Path path;
@Override
protected void setUp() throws Exception {
super.setUp();
path = Files.createTempFile("File", ".tmp");
}
@Override
protected void tearDown() throws Exception {
Files.delete(path);
super.tearDown();
}
}
Improved code:
public class AnotherTest extends CompanyTestCase {
private Path path;
@Override
protected void setUp() throws Exception {
super.setUp();
path = Files.createTempFile("File", ".tmp");
}
@Override
protected void tearDown() throws Exception {
try {
Files.delete(path);
} finally {
super.tearDown();
}
}
}