Class OutputClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class OutputClient : ClientBase
Constructors
OutputClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public OutputClient(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
GetAsync(String, CancellationToken)
Get output
Declaration
public virtual async Task<OutputDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Output 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<OutputDetail>
Output detail |
Remarks
Gets a output document by id.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<OutputClient.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<OutputClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
ResetRetryAttemptsAsync(OutputResetRetryAttemptsRequest, CancellationToken)
Resets retry attempt counters.
Declaration
public virtual async Task<BusinessProcess> ResetRetryAttemptsAsync(OutputResetRetryAttemptsRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputResetRetryAttemptsRequest
request
Request containing options to filter which outputs should be reset. |
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 tracking the resetting |
Remarks
Resets retry attempt counters on failed (optionally also completed) outputs and they will be subsequently picked up for re-rendering.
The number the counters are reset to is determined by a global configuration value. If OutputIds are specified, the rest of the fields are ignored.
Can reset 100 outputs at most. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
SearchAsync(OutputSearchRequest, CancellationToken)
Search output documents
Declaration
public virtual async Task<OutputSearchResult> SearchAsync(OutputSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputSearchRequest
request
The output 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<OutputSearchResult>
Output result set |
Remarks
ContentIds must be mandatory filled.