Interface IXmpMappingClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IXmpMappingClient
Methods
CreateAsync(XmpMappingEntryCreateRequest, CancellationToken)
Create xmp mapping
Declaration
Task<BusinessProcess> CreateAsync(XmpMappingEntryCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
XmpMappingEntryCreateRequest
request
Request containing information needed to create new xmp mapping. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CreateManyAsync(XmpMappingEntryCreateManyRequest, CancellationToken)
Create multiple xmp mappings
Declaration
Task<BusinessProcess> CreateManyAsync(XmpMappingEntryCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
XmpMappingEntryCreateManyRequest
request
Request containing information needed to create new xmp mapping. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteAsync(String, CancellationToken)
Delete xmp mapping
Declaration
Task<BusinessProcess> DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Xmp mapping ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteManyAsync(XmpMappingEntryDeleteManyRequest, CancellationToken)
Delete multiple xmp mappings
Declaration
Task<BusinessProcess> DeleteManyAsync(XmpMappingEntryDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
XmpMappingEntryDeleteManyRequest
request
The request with xmp mapping IDs to delete. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAsync(String, CancellationToken)
Get xmp mapping
Declaration
Task<XmpMappingEntry> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Xmp mapping ID. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<XmpMappingEntry>
XMP mapping entry |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAvailableTargetsAsync(CancellationToken)
Gets fields available for XMP mapping.
Declaration
Task<XmpMappingTargets> GetAvailableTargetsAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<XmpMappingTargets>
XmpMappingTargets containing both XMP fields and metadata fields that are available for mapping. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple xmp mappings
Declaration
Task<ICollection<XmpMappingEntry>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
Xmp mapping IDs to get information about. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<XmpMappingEntry>>
Array of XMP mapping entry |
Exceptions
ApiException
A server side error occurred. |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
PictureparkValidationException
Validation exception |
RequestSizeLimitExceededException
List of IDs exceeded maximum size |
SearchAsync(XmpMappingEntrySearchRequest, CancellationToken)
Searches for XMP mappings
Declaration
Task<XmpMappingEntrySearchResult> SearchAsync(XmpMappingEntrySearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
XmpMappingEntrySearchRequest
request
Search request for getting configured XMP mappings. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<XmpMappingEntrySearchResult>
Holds results of search for XMP mappings |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
UpdateAsync(String, XmpMappingEntry, CancellationToken)
Update xmp mapping
Declaration
Task<BusinessProcess> UpdateAsync(string id, XmpMappingEntry request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Xmp mapping ID. |
XmpMappingEntry
request
Request containing information needed to update the xmp mapping. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
UpdateManyAsync(XmpMappingEntryUpdateManyRequest, CancellationToken)
Update multiple xmp mappings
Declaration
Task<BusinessProcess> UpdateManyAsync(XmpMappingEntryUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
XmpMappingEntryUpdateManyRequest
request
Request containing information needed to update the xmp mapping. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |