Interface IConversionPresetTemplateClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IConversionPresetTemplateClient
Methods
CreateAsync(ConversionPresetTemplateCreateRequest, Nullable<TimeSpan>, CancellationToken)
Create conversion preset template
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CreateManyAsync(ConversionPresetTemplateCreateManyRequest, CancellationToken)
Create multiple conversion preset templates
Declaration
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 |
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, Nullable<TimeSpan>, CancellationToken)
Delete conversion preset template
Declaration
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
|
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteManyAsync(ConversionPresetTemplateDeleteManyRequest, CancellationToken)
Delete multiple conversion preset templates
Declaration
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 |
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 conversion preset template
Declaration
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 |
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 conversion preset templates
Declaration
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 |
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(ConversionPresetTemplateSearchRequest, CancellationToken)
Search conversion preset templates
Declaration
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 |
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, ConversionPresetTemplateUpdateRequest, Nullable<TimeSpan>, CancellationToken)
Update conversion preset template
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
UpdateManyAsync(ConversionPresetTemplateUpdateManyRequest, CancellationToken)
Update multiple conversion preset templates
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |