Interface ITemplateClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface ITemplateClient
Methods
CreateAsync(TemplateCreateRequest, CancellationToken)
Create template
Declaration
Task<Template> CreateAsync(TemplateCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
TemplateCreateRequest
request
TemplateCreateRequest |
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<Template>
Template |
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, CancellationToken)
Delete template
Declaration
Task DeleteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of 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
|
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAllAsync(CancellationToken)
Get all templates
Declaration
Task<ICollection<Template>> GetAllAsync(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<System.Collections.Generic.ICollection<Template>>
All templates |
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 template
Declaration
Task<Template> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of 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<Template>
Template |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SearchAsync(TemplateSearchRequest, CancellationToken)
Search templates
Declaration
Task<TemplateSearchResult> SearchAsync(TemplateSearchRequest searchRequest, CancellationToken cancellationToken = default(CancellationToken))
Parameters
TemplateSearchRequest
searchRequest
The template 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<TemplateSearchResult>
Template search result |
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, TemplateUpdateRequest, CancellationToken)
Update template
Declaration
Task<Template> UpdateAsync(string id, TemplateUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of template. |
TemplateUpdateRequest
request
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<Template>
Template |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |