Skip to content

Commit 4d4474a

Browse files
author
[email protected]
committed
#PDFCLOUD-4491 ClientSDK: Add XmpMetadata methods
1 parent 60d9f03 commit 4d4474a

File tree

7 files changed

+963
-1
lines changed

7 files changed

+963
-1
lines changed

‎docs/PdfApi.md‎

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PdfApi
1+
# PdfApi
22

33
All URIs are relative to *https://api.aspose.cloud/v3.0*
44

@@ -189,6 +189,8 @@ Method | HTTP request | Description
189189
[**getWordsPerPage**](PdfApi.md#getWordsPerPage) | **GET** /pdf/\{name}/pages/wordCount | Get number of words per document page.
190190
[**getXfaPdfInStorageToAcroForm**](PdfApi.md#getXfaPdfInStorageToAcroForm) | **GET** /pdf/\{name}/convert/xfatoacroform | Converts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
191191
[**getXmlInStorageToPdf**](PdfApi.md#getXmlInStorageToPdf) | **GET** /pdf/create/xml | Convert XML file (located on storage) to PDF format and return resulting file in response.
192+
[**getXmpMetadataJson**](PdfApi.md#getXmpMetadataJson) | **GET** /pdf/\{name}/xmpmetadata/json | Gets document XMP Metadata as JSON.
193+
[**getXmpMetadataXml**](PdfApi.md#getXmpMetadataXml) | **GET** /pdf/\{name}/xmpmetadata/xml | Gets document XMP Metadata as XML file.
192194
[**getXpsInStorageToPdf**](PdfApi.md#getXpsInStorageToPdf) | **GET** /pdf/create/xps | Convert XPS file (located on storage) to PDF format and return resulting file in response.
193195
[**getXslFoInStorageToPdf**](PdfApi.md#getXslFoInStorageToPdf) | **GET** /pdf/create/xslfo | Convert XslFo file (located on storage) to PDF format and return resulting file in response.
194196
[**moveFile**](PdfApi.md#moveFile) | **PUT** /pdf/storage/file/move/\{srcPath} | Move file
@@ -258,6 +260,7 @@ Method | HTTP request | Description
258260
[**postSplitDocument**](PdfApi.md#postSplitDocument) | **POST** /pdf/\{name}/split | Split document to parts.
259261
[**postSplitRangePdfDocument**](PdfApi.md#postSplitRangePdfDocument) | **POST** /pdf/\{name}/splitrangepdf | Split document into ranges.
260262
[**postTextBoxFields**](PdfApi.md#postTextBoxFields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
263+
[**postXmpMetadata**](PdfApi.md#postXmpMetadata) | **POST** /pdf/\{name}/xmpmetadata | Add or remove XMP Metadata properties.
261264
[**putAddNewPage**](PdfApi.md#putAddNewPage) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
262265
[**putAddText**](PdfApi.md#putAddText) | **PUT** /pdf/\{name}/pages/\{pageNumber}/text | Add text to PDF document page.
263266
[**putAnnotationsFlatten**](PdfApi.md#putAnnotationsFlatten) | **PUT** /pdf/\{name}/annotations/flatten | Flattens the annotations of the specified types
@@ -4869,6 +4872,54 @@ Name | Type | Description | Notes
48694872

48704873
**File**
48714874

4875+
### HTTP request headers
4876+
4877+
- **Content-Type**: application/json
4878+
- **Accept**: multipart/form-data
4879+
4880+
<a name="getXmpMetadataJson"></a>
4881+
# **getXmpMetadataJson**
4882+
> XmpMetadata getXmpMetadataJson(name, folder, storage, passBase64)
4883+
4884+
Gets document XMP Metadata as JSON.
4885+
4886+
### Parameters
4887+
4888+
Name | Type | Description | Notes
4889+
------------- | ------------- | ------------- | -------------
4890+
**name** | **String**| The document name. |
4891+
**folder** | **String**| The document folder. | [optional]
4892+
**storage** | **String**| The document storage. | [optional]
4893+
**passBase64** | **String**| The password (Base64). | [optional]
4894+
4895+
### Return type
4896+
4897+
[**XmpMetadata**](XmpMetadata.md)
4898+
4899+
### HTTP request headers
4900+
4901+
- **Content-Type**: application/json
4902+
- **Accept**: application/json
4903+
4904+
<a name="getXmpMetadataXml"></a>
4905+
# **getXmpMetadataXml**
4906+
> File getXmpMetadataXml(name, folder, storage, passBase64)
4907+
4908+
Gets document XMP Metadata as XML file.
4909+
4910+
### Parameters
4911+
4912+
Name | Type | Description | Notes
4913+
------------- | ------------- | ------------- | -------------
4914+
**name** | **String**| The document name. |
4915+
**folder** | **String**| The document folder. | [optional]
4916+
**storage** | **String**| The document storage. | [optional]
4917+
**passBase64** | **String**| The password (Base64). | [optional]
4918+
4919+
### Return type
4920+
4921+
**File**
4922+
48724923
### HTTP request headers
48734924

48744925
- **Content-Type**: application/json
@@ -6596,6 +6647,31 @@ Name | Type | Description | Notes
65966647

65976648
[**AsposeResponse**](AsposeResponse.md)
65986649

6650+
### HTTP request headers
6651+
6652+
- **Content-Type**: application/json
6653+
- **Accept**: application/json
6654+
6655+
<a name="postXmpMetadata"></a>
6656+
# **postXmpMetadata**
6657+
> AsposeResponse postXmpMetadata(name, metadata, folder, storage, passBase64)
6658+
6659+
Add or remove XMP Metadata properties.
6660+
6661+
### Parameters
6662+
6663+
Name | Type | Description | Notes
6664+
------------- | ------------- | ------------- | -------------
6665+
**name** | **String**| The document name. |
6666+
**metadata** | [**XmpMetadata**](XmpMetadata.md)| XmpMetadata instance. |
6667+
**folder** | **String**| The document folder. | [optional]
6668+
**storage** | **String**| The document storage. | [optional]
6669+
**passBase64** | **String**| The password (Base64). | [optional]
6670+
6671+
### Return type
6672+
6673+
[**AsposeResponse**](AsposeResponse.md)
6674+
65996675
### HTTP request headers
66006676

66016677
- **Content-Type**: application/json

‎docs/XmpMetadata.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
# XmpMetadata
3+
Document Xmp Metadata.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**properties** | [**List&lt;XmpMetadataProperty&gt;**](XmpMetadataProperty.md) | List of document Xmp Metadata default properties. | [optional]
9+
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎docs/XmpMetadataProperty.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
# XmpMetadataProperty
3+
Xmp Metadata Property.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**key** | **String** | Xmp Metadata Property Key. Can take the form for default keys: xmp:DefaultKeyName or DefaultKeyName. Form for user defined properties: customNamespace:UserPropertyName. |
9+
**value** | **String** | Xmp Metadata Property Value. Null for delete property. | [optional]
10+
**namespaceUri** | **String** | Namespace Uri. For user defined properties only. | [optional]
11+
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

0 commit comments

Comments
 (0)