Class ConversionPresetTemplateClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class ConversionPresetTemplateClient : ClientBase
Constructors
ConversionPresetTemplateClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public ConversionPresetTemplateClient(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(ConversionPresetTemplateCreateRequest, Nullable<TimeSpan>, CancellationToken)
Create conversion preset template
Declaration
public virtual async Task<ConversionPresetTemplateDetail> CreateAsync(ConversionPresetTemplateCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ConversionPresetTemplateCreateRequest
request
Request containing information needed to create new conversion preset template. |
System.Nullable<System.TimeSpan>
timeout
Timeout |
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<ConversionPresetTemplateDetail>
Represents the detail of a conversion preset template |
Remarks
Creates new conversion preset template based on the supplied request.
CreateManyAsync(ConversionPresetTemplateCreateManyRequest, CancellationToken)
Create multiple conversion preset templates
Declaration
public virtual async Task<BusinessProcess> CreateManyAsync(ConversionPresetTemplateCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ConversionPresetTemplateCreateManyRequest
request
Request containing information needed to create new conversion preset template. |
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 conversion preset templates based on supplied requests. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
DeleteAsync(String, Nullable<TimeSpan>, CancellationToken)
Delete conversion preset template
Declaration
public virtual async Task DeleteAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Conversion preset template ID. |
System.Nullable<System.TimeSpan>
timeout
Timeout |
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
|
Remarks
Deletes the conversion preset template specified by the ID.
DeleteManyAsync(ConversionPresetTemplateDeleteManyRequest, CancellationToken)
Delete multiple conversion preset templates
Declaration
public virtual async Task<BusinessProcess> DeleteManyAsync(ConversionPresetTemplateDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ConversionPresetTemplateDeleteManyRequest
request
The request with conversion preset template 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 conversion preset templates 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 conversion preset template
Declaration
public virtual async Task<ConversionPresetTemplateDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Conversion preset template 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<ConversionPresetTemplateDetail>
Represents the detail of a conversion preset template |
Remarks
Gets the conversion preset template by the conversion preset template ID.
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple conversion preset templates
Declaration
public virtual async Task<ICollection<ConversionPresetTemplateDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
Conversion preset template 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<ConversionPresetTemplateDetail>>
Array of Represents the detail of a conversion preset template |
Remarks
Gets multiple conversion preset template details by the conversion preset template IDs. Can fetch maximum of 100 conversion preset templates at once.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<ConversionPresetTemplateClient.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<ConversionPresetTemplateClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
SearchAsync(ConversionPresetTemplateSearchRequest, CancellationToken)
Search conversion preset templates
Declaration
public virtual async Task<ConversionPresetTemplateSearchResult> SearchAsync(ConversionPresetTemplateSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ConversionPresetTemplateSearchRequest
request
Conversion preset templates search request. |
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<ConversionPresetTemplateSearchResult>
Result of the conversion preset templates search |
UpdateAsync(String, ConversionPresetTemplateUpdateRequest, Nullable<TimeSpan>, CancellationToken)
Update conversion preset template
Declaration
public virtual async Task<ConversionPresetTemplateDetail> UpdateAsync(string id, ConversionPresetTemplateUpdateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Conversion preset template ID. |
ConversionPresetTemplateUpdateRequest
request
Request containing information needed to update the conversion preset template. |
System.Nullable<System.TimeSpan>
timeout
Timeout |
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<ConversionPresetTemplateDetail>
Represents the detail of a conversion preset template |
Remarks
Updates the conversion preset template specified by the ID and based on supplied request.
UpdateManyAsync(ConversionPresetTemplateUpdateManyRequest, CancellationToken)
Update multiple conversion preset templates
Declaration
public virtual async Task<BusinessProcess> UpdateManyAsync(ConversionPresetTemplateUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
ConversionPresetTemplateUpdateManyRequest
request
Request containing information needed to update the conversion preset template. |
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 conversion preset templates 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.