Class TemplateClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class TemplateClient : ClientBase
Constructors
TemplateClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public TemplateClient(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(TemplateCreateRequest, CancellationToken)
Create template
Declaration
public virtual async 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 |
DeleteAsync(String, CancellationToken)
Delete template
Declaration
public virtual async 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
|
GetAllAsync(CancellationToken)
Get all templates
Declaration
public virtual async 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 |
GetAsync(String, CancellationToken)
Get template
Declaration
public virtual async 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 |
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<TemplateClient.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<TemplateClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
SearchAsync(TemplateSearchRequest, CancellationToken)
Search templates
Declaration
public virtual async 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 |
Remarks
All matching templates are returned. No pagination is implemented.
UpdateAsync(String, TemplateUpdateRequest, CancellationToken)
Update template
Declaration
public virtual async 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 |