Class ConversionPresetTemplateClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ConversionPresetTemplateClient : ClientBase, IConversionPresetTemplateClientConstructors
ConversionPresetTemplateClient(IPictureparkServiceSettings, HttpClient)
Declaration
public ConversionPresetTemplateClient(IPictureparkServiceSettings configuration, HttpClient httpClient)Parameters
| IPictureparkServiceSettings configuration |
| HttpClient httpClient |
Properties
JsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }Property Value
| JsonSerializerSettings |
ReadResponseAsString
Methods
CreateAsync(ConversionPresetTemplateCreateRequest, TimeSpan?, CancellationToken)
Create conversion preset template
Declaration
public virtual Task<ConversionPresetTemplateDetail> CreateAsync(ConversionPresetTemplateCreateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
ConversionPresetTemplateCreateRequest
request
Request containing information needed to create new conversion preset template. |
|
TimeSpan?
timeout
Timeout |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ConversionPresetTemplateDetail>
Represents the detail of a conversion preset template |
Implements
Remarks
Creates new conversion preset template based on the supplied request.
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(ConversionPresetTemplateCreateManyRequest, CancellationToken)
Create multiple conversion preset templates
Declaration
public virtual Task<BusinessProcess> CreateManyAsync(ConversionPresetTemplateCreateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ConversionPresetTemplateCreateManyRequest
request
Request containing information needed to create new conversion preset template. |
|
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
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.
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, TimeSpan?, CancellationToken)
Delete conversion preset template
Declaration
public virtual Task DeleteAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
string
id
Conversion preset template ID. |
|
TimeSpan?
timeout
Timeout |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Implements
Remarks
Deletes the conversion preset template specified by the 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 |
DeleteManyAsync(ConversionPresetTemplateDeleteManyRequest, CancellationToken)
Delete multiple conversion preset templates
Declaration
public virtual Task<BusinessProcess> DeleteManyAsync(ConversionPresetTemplateDeleteManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ConversionPresetTemplateDeleteManyRequest
request
The request with conversion preset template 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
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.
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 conversion preset template
Declaration
public virtual Task<ConversionPresetTemplateDetail> GetAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Conversion preset template ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ConversionPresetTemplateDetail>
Represents the detail of a conversion preset template |
Implements
Remarks
Gets the conversion preset template by the conversion preset template 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 |
GetManyAsync(IEnumerable<string>, CancellationToken)
Get multiple conversion preset templates
Declaration
public virtual Task<ICollection<ConversionPresetTemplateDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
Conversion preset template 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<ConversionPresetTemplateDetail>>
Array of Represents the detail of a conversion preset template |
Implements
Remarks
Gets multiple conversion preset template details by the conversion preset template IDs. Can fetch maximum of 100 conversion preset templates 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<ConversionPresetTemplateClient.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<ConversionPresetTemplateClient.ObjectResponseResult<T>> |
Type Parameters
| T |
SearchAsync(ConversionPresetTemplateSearchRequest, CancellationToken)
Search conversion preset templates
Declaration
public virtual Task<ConversionPresetTemplateSearchResult> SearchAsync(ConversionPresetTemplateSearchRequest request, CancellationToken cancellationToken = default)Parameters
|
ConversionPresetTemplateSearchRequest
request
Conversion preset templates search request. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ConversionPresetTemplateSearchResult>
Result of the conversion preset templates search |
Implements
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, ConversionPresetTemplateUpdateRequest, TimeSpan?, CancellationToken)
Update conversion preset template
Declaration
public virtual Task<ConversionPresetTemplateDetail> UpdateAsync(string id, ConversionPresetTemplateUpdateRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default)Parameters
|
string
id
Conversion preset template ID. |
|
ConversionPresetTemplateUpdateRequest
request
Request containing information needed to update the conversion preset template. |
|
TimeSpan?
timeout
Timeout |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ConversionPresetTemplateDetail>
Represents the detail of a conversion preset template |
Implements
Remarks
Updates the conversion preset template specified by the ID and based on supplied request.
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(ConversionPresetTemplateUpdateManyRequest, CancellationToken)
Update multiple conversion preset templates
Declaration
public virtual Task<BusinessProcess> UpdateManyAsync(ConversionPresetTemplateUpdateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ConversionPresetTemplateUpdateManyRequest
request
Request containing information needed to update the conversion preset template. |
|
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
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.
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 |