Class XmpMappingClient

Inheritance

object

ClientBase

XmpMappingClient

Inherited Members

ClientBase.BaseUrl

ClientBase.CustomerAlias

ClientBase.CreateHttpRequestMessageAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class XmpMappingClient : ClientBase, IXmpMappingClient

Constructors

XmpMappingClient(IPictureparkServiceSettings, HttpClient)

Declaration

public XmpMappingClient(IPictureparkServiceSettings configuration, HttpClient httpClient)

Parameters

IPictureparkServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

CreateAsync(XmpMappingEntryCreateRequest, CancellationToken)

Create xmp mapping

Declaration

public virtual Task<BusinessProcess> CreateAsync(XmpMappingEntryCreateRequest request, CancellationToken cancellationToken = default)

Parameters

XmpMappingEntryCreateRequest request Request containing information needed to create new xmp mapping.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IXmpMappingClient.CreateAsync(XmpMappingEntryCreateRequest, CancellationToken)

Remarks

Creates new xmp mapping based on the supplied request. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

CreateManyAsync(XmpMappingEntryCreateManyRequest, CancellationToken)

Create multiple xmp mappings

Declaration

public virtual Task<BusinessProcess> CreateManyAsync(XmpMappingEntryCreateManyRequest request, CancellationToken cancellationToken = default)

Parameters

XmpMappingEntryCreateManyRequest request Request containing information needed to create new xmp mapping.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IXmpMappingClient.CreateManyAsync(XmpMappingEntryCreateManyRequest, CancellationToken)

Remarks

Creates new xmp mappings based on supplied requests. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

DeleteAsync(string, CancellationToken)

Delete xmp mapping

Declaration

public virtual Task<BusinessProcess> DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

string id Xmp mapping ID.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IXmpMappingClient.DeleteAsync(string, CancellationToken)

Remarks

Deletes the xmp mapping specified by the ID. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

DeleteManyAsync(XmpMappingEntryDeleteManyRequest, CancellationToken)

Delete multiple xmp mappings

Declaration

public virtual Task<BusinessProcess> DeleteManyAsync(XmpMappingEntryDeleteManyRequest request, CancellationToken cancellationToken = default)

Parameters

XmpMappingEntryDeleteManyRequest request The request with xmp mapping IDs to delete.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IXmpMappingClient.DeleteManyAsync(XmpMappingEntryDeleteManyRequest, CancellationToken)

Remarks

Deletes the xmp mappings specified by the IDs. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAsync(string, CancellationToken)

Get xmp mapping

Declaration

public virtual Task<XmpMappingEntry> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

string id Xmp mapping ID.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<XmpMappingEntry> XMP mapping entry

Implements

IXmpMappingClient.GetAsync(string, CancellationToken)

Remarks

Gets the xmp mapping by the xmp mapping ID.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetAvailableTargetsAsync(CancellationToken)

Gets fields available for XMP mapping.

Declaration

public virtual Task<XmpMappingTargets> GetAvailableTargetsAsync(CancellationToken cancellationToken = default)

Parameters

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<XmpMappingTargets> XmpMappingTargets containing both XMP fields and metadata fields that are available for mapping.

Implements

IXmpMappingClient.GetAvailableTargetsAsync(CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

GetManyAsync(IEnumerable<string>, CancellationToken)

Get multiple xmp mappings

Declaration

public virtual Task<ICollection<XmpMappingEntry>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)

Parameters

IEnumerable<string> ids Xmp mapping IDs to get information about.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ICollection<XmpMappingEntry>> Array of XMP mapping entry

Implements

IXmpMappingClient.GetManyAsync(IEnumerable<string>, CancellationToken)

Remarks

Gets multiple xmp mapping details by the xmp mapping IDs. Can fetch maximum of 100 xmp mappings at once.

Exceptions

ApiException A server side error occurred.

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

PictureparkValidationException Validation exception

RequestSizeLimitExceededException List of IDs exceeded maximum size

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<XmpMappingClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

HttpResponseMessage response

IReadOnlyDictionary<string, IEnumerable<string>> headers

CancellationToken cancellationToken

Returns

Task<XmpMappingClient.ObjectResponseResult<T>>

Type Parameters

T

SearchAsync(XmpMappingEntrySearchRequest, CancellationToken)

Searches for XMP mappings

Declaration

public virtual Task<XmpMappingEntrySearchResult> SearchAsync(XmpMappingEntrySearchRequest request, CancellationToken cancellationToken = default)

Parameters

XmpMappingEntrySearchRequest request Search request for getting configured XMP mappings.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<XmpMappingEntrySearchResult> Holds results of search for XMP mappings

Implements

IXmpMappingClient.SearchAsync(XmpMappingEntrySearchRequest, CancellationToken)

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

UpdateAsync(string, XmpMappingEntry, CancellationToken)

Update xmp mapping

Declaration

public virtual Task<BusinessProcess> UpdateAsync(string id, XmpMappingEntry request, CancellationToken cancellationToken = default)

Parameters

string id Xmp mapping ID.

XmpMappingEntry request Request containing information needed to update the xmp mapping.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IXmpMappingClient.UpdateAsync(string, XmpMappingEntry, CancellationToken)

Remarks

Updates the xmp mapping specified by the ID and based on supplied request. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

UpdateManyAsync(XmpMappingEntryUpdateManyRequest, CancellationToken)

Update multiple xmp mappings

Declaration

public virtual Task<BusinessProcess> UpdateManyAsync(XmpMappingEntryUpdateManyRequest request, CancellationToken cancellationToken = default)

Parameters

XmpMappingEntryUpdateManyRequest request Request containing information needed to update the xmp mapping.

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IXmpMappingClient.UpdateManyAsync(XmpMappingEntryUpdateManyRequest, CancellationToken)

Remarks

Updates the xmp mappings specified by the IDs and based on supplied requests. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error