Class XmpMappingClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class XmpMappingClient : ClientBase
Constructors
XmpMappingClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public XmpMappingClient(Contract.IPictureparkServiceSettings configuration, Http.HttpClient httpClient)
Parameters
Picturepark.SDK.V1.Contract.IPictureparkServiceSettings
configuration
|
System.Net.Http.HttpClient
httpClient
|
Properties
JsonSerializerSettings
Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Newtonsoft.Json.JsonSerializerSettings
|
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
System.Boolean
|
Methods
CreateAsync(XmpMappingEntryCreateRequest, CancellationToken)
Create xmp mapping
Declaration
public virtual async 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 |
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.
CreateManyAsync(XmpMappingEntryCreateManyRequest, CancellationToken)
Create multiple xmp mappings
Declaration
public virtual async 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 |
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.
DeleteAsync(String, CancellationToken)
Delete xmp mapping
Declaration
public virtual async 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 |
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.
DeleteManyAsync(XmpMappingEntryDeleteManyRequest, CancellationToken)
Delete multiple xmp mappings
Declaration
public virtual async 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 |
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.
GetAsync(String, CancellationToken)
Get xmp mapping
Declaration
public virtual async 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 |
Remarks
Gets the xmp mapping by the xmp mapping ID.
GetAvailableTargetsAsync(CancellationToken)
Gets fields available for XMP mapping.
Declaration
public virtual async 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. |
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple xmp mappings
Declaration
public virtual async 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 |
Remarks
Gets multiple xmp mapping details by the xmp mapping IDs. Can fetch maximum of 100 xmp mappings at once.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<XmpMappingClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(Http.HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
System.Net.Http.HttpResponseMessage
response
|
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>
headers
|
System.Threading.CancellationToken
cancellationToken
|
Returns
System.Threading.Tasks.Task<XmpMappingClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
SearchAsync(XmpMappingEntrySearchRequest, CancellationToken)
Searches for XMP mappings
Declaration
public virtual async 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 |
UpdateAsync(String, XmpMappingEntry, CancellationToken)
Update xmp mapping
Declaration
public virtual async 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 |
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.
UpdateManyAsync(XmpMappingEntryUpdateManyRequest, CancellationToken)
Update multiple xmp mappings
Declaration
public virtual async 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 |
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.