Skip to content

Commit 6f2679c

Browse files
add Url API in DocumentAPI
1 parent a3344fa commit 6f2679c

25 files changed

+1870
-734
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,17 @@ Class | Method | HTTP request | Description
213213
*Asposehtmlcloud.ConversionApi* | [**GetConvertDocumentToPdfByUrl**](docs/ConversionApi.md#GetConvertDocumentToPdfByUrl) | **GET** /html/convert/pdf | Convert the HTML page from the web by its URL to PDF.
214214
*Asposehtmlcloud.ConversionApi* | [**GetConvertDocumentToXps**](docs/ConversionApi.md#GetConvertDocumentToXps) | **GET** /html/{name}/convert/xps | Convert the HTML document from the storage by its name to XPS.
215215
*Asposehtmlcloud.ConversionApi* | [**GetConvertDocumentToXpsByUrl**](docs/ConversionApi.md#GetConvertDocumentToXpsByUrl) | **GET** /html/convert/xps | Convert the HTML page from the web by its URL to XPS.
216+
*Asposehtmlcloud.ConversionApi* | [**PutConvertDocumentInRequestToImage**](docs/ConversionApi.md#PutConvertDocumentInRequestToImage) | **PUT** /html/convert/image/{outFormat} | Converts the HTML document (in request content) to the specified image format and uploads resulting file to storage.
217+
*Asposehtmlcloud.ConversionApi* | [**PutConvertDocumentInRequestToPdf**](docs/ConversionApi.md#PutConvertDocumentInRequestToPdf) | **PUT** /html/convert/pdf | Converts the HTML document (in request content) to PDF and uploads resulting file to storage.
218+
*Asposehtmlcloud.ConversionApi* | [**PutConvertDocumentInRequestToXps**](docs/ConversionApi.md#PutConvertDocumentInRequestToXps) | **PUT** /html/convert/xps | Converts the HTML document (in request content) to XPS and uploads resulting file to storage.
219+
*Asposehtmlcloud.ConversionApi* | [**PutConvertDocumentToImage**](docs/ConversionApi.md#PutConvertDocumentToImage) | **PUT** /html/{name}/convert/image/{outFormat} | Converts the HTML document (located on storage) to the specified image format and uploads resulting file to storage.
220+
*Asposehtmlcloud.ConversionApi* | [**PutConvertDocumentToPdf**](docs/ConversionApi.md#PutConvertDocumentToPdf) | **PUT** /html/{name}/convert/pdf | Converts the HTML document (located on storage) to PDF and uploads resulting file to storage.
221+
*Asposehtmlcloud.ConversionApi* | [**PutConvertDocumentToXps**](docs/ConversionApi.md#PutConvertDocumentToXps) | **PUT** /html/{name}/convert/xps | Converts the HTML document (located on storage) to XPS and uploads resulting file to storage.
216222
*Asposehtmlcloud.DocumentApi* | [**GetDocument**](docs/DocumentApi.md#GetDocument) | **GET** /html/{name} | Return the HTML document by the name from default or specified storage.
217223
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentByXPath**](docs/DocumentApi.md#GetDocumentFragmentByXPath) | **GET** /html/{name}/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query.
224+
*Asposehtmlcloud.DocumentApi* | [**GetDocumentFragmentByXPathByUrl**](docs/DocumentApi.md#GetDocumentFragmentByXPathByUrl) | **GET** /html/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query by the source page URL.
218225
*Asposehtmlcloud.DocumentApi* | [**GetDocumentImages**](docs/DocumentApi.md#GetDocumentImages) | **GET** /html/{name}/images/all | Return all HTML document images packaged as a ZIP archive.
226+
*Asposehtmlcloud.DocumentApi* | [**GetDocumentImagesByUrl**](docs/DocumentApi.md#GetDocumentImagesByUrl) | **GET** /html/images/all | Return all HTML page images packaged as a ZIP archive by the source page URL.
219227
*Asposehtmlcloud.OcrApi* | [**GetRecognizeAndImportToHtml**](docs/OcrApi.md#GetRecognizeAndImportToHtml) | **GET** /html/{name}/ocr/import | Recognize text from the image file in the storage and import it to HTML format.
220228
*Asposehtmlcloud.OcrApi* | [**GetRecognizeAndTranslateToHtml**](docs/OcrApi.md#GetRecognizeAndTranslateToHtml) | **GET** /html/{name}/ocr/translate/{srcLang}/{resLang} | Recognize text from the image file in the storage, import it to HTML format and translate to specified language.
221229
*Asposehtmlcloud.TranslationApi* | [**GetTranslateDocument**](docs/TranslationApi.md#GetTranslateDocument) | **GET** /html/{name}/translate/{srcLang}/{resLang} | Translate the HTML document specified by the name from default or specified storage.

docs/ConversionApi.md

Lines changed: 418 additions & 46 deletions
Large diffs are not rendered by default.

docs/DocumentApi.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**GetDocument**](DocumentApi.md#GetDocument) | **GET** /html/{name} | Return the HTML document by the name from default or specified storage.
88
[**GetDocumentFragmentByXPath**](DocumentApi.md#GetDocumentFragmentByXPath) | **GET** /html/{name}/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query.
9+
[**GetDocumentFragmentByXPathByUrl**](DocumentApi.md#GetDocumentFragmentByXPathByUrl) | **GET** /html/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query by the source page URL.
910
[**GetDocumentImages**](DocumentApi.md#GetDocumentImages) | **GET** /html/{name}/images/all | Return all HTML document images packaged as a ZIP archive.
11+
[**GetDocumentImagesByUrl**](DocumentApi.md#GetDocumentImagesByUrl) | **GET** /html/images/all | Return all HTML page images packaged as a ZIP archive by the source page URL.
1012

1113

1214
<a name="GetDocument"></a>
@@ -102,6 +104,52 @@ Name | Type | Description | Notes
102104

103105
**File**
104106

107+
### HTTP request headers
108+
109+
- **Content-Type**: application/json
110+
- **Accept**: multipart/form-data
111+
112+
<a name="GetDocumentFragmentByXPathByUrl"></a>
113+
# **GetDocumentFragmentByXPathByUrl**
114+
> File GetDocumentFragmentByXPathByUrl(sourceUrl, xPath, outFormat)
115+
116+
Return list of HTML fragments matching the specified XPath query by the source page URL.
117+
118+
### Example
119+
```javascript
120+
var Asposehtmlcloud = require('asposehtmlcloud');
121+
122+
var apiInstance = new Asposehtmlcloud.DocumentApi();
123+
124+
var sourceUrl = "sourceUrl_example"; // String | Source page URL.
125+
126+
var xPath = "xPath_example"; // String | XPath query string.
127+
128+
var outFormat = "outFormat_example"; // String | Output format. Possible values: 'plain' and 'json'.
129+
130+
131+
var callback = function(error, data, response) {
132+
if (error) {
133+
console.error(error);
134+
} else {
135+
console.log('API called successfully. Returned data: ' + data);
136+
}
137+
};
138+
apiInstance.GetDocumentFragmentByXPathByUrl(sourceUrl, xPath, outFormat, callback);
139+
```
140+
141+
### Parameters
142+
143+
Name | Type | Description | Notes
144+
------------- | ------------- | ------------- | -------------
145+
**sourceUrl** | **String**| Source page URL. |
146+
**xPath** | **String**| XPath query string. |
147+
**outFormat** | **String**| Output format. Possible values: &#39;plain&#39; and &#39;json&#39;. |
148+
149+
### Return type
150+
151+
**File**
152+
105153
### HTTP request headers
106154

107155
- **Content-Type**: application/json
@@ -153,3 +201,43 @@ Name | Type | Description | Notes
153201
- **Content-Type**: application/json
154202
- **Accept**: application/zip
155203

204+
<a name="GetDocumentImagesByUrl"></a>
205+
# **GetDocumentImagesByUrl**
206+
> File GetDocumentImagesByUrl(sourceUrl)
207+
208+
Return all HTML page images packaged as a ZIP archive by the source page URL.
209+
210+
### Example
211+
```javascript
212+
var Asposehtmlcloud = require('asposehtmlcloud');
213+
214+
var apiInstance = new Asposehtmlcloud.DocumentApi();
215+
216+
var sourceUrl = "sourceUrl_example"; // String | Source page URL.
217+
218+
219+
var callback = function(error, data, response) {
220+
if (error) {
221+
console.error(error);
222+
} else {
223+
console.log('API called successfully. Returned data: ' + data);
224+
}
225+
};
226+
apiInstance.GetDocumentImagesByUrl(sourceUrl, callback);
227+
```
228+
229+
### Parameters
230+
231+
Name | Type | Description | Notes
232+
------------- | ------------- | ------------- | -------------
233+
**sourceUrl** | **String**| Source page URL. |
234+
235+
### Return type
236+
237+
**File**
238+
239+
### HTTP request headers
240+
241+
- **Content-Type**: application/json
242+
- **Accept**: application/zip
243+

0 commit comments

Comments
 (0)