Class OutputFormatClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class OutputFormatClient : ClientBase
Constructors
OutputFormatClient(Contract.IPictureparkServiceSettings, Http.HttpClient)
Declaration
public OutputFormatClient(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
CreateCoreAsync(OutputFormat, CancellationToken)
Create output format
Declaration
protected virtual async Task<BusinessProcess> CreateCoreAsync(OutputFormat request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormat
request
Request containing information needed to create new output format. |
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 |
Remarks
Creates new output format based on the supplied request. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
CreateManyCoreAsync(OutputFormatCreateManyRequest, CancellationToken)
Create multiple output formats
Declaration
protected virtual async Task<BusinessProcess> CreateManyCoreAsync(OutputFormatCreateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatCreateManyRequest
request
Request containing information needed to create new output format. |
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 |
Remarks
Creates new output formats based on supplied requests. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
DeleteCoreAsync(String, CancellationToken)
Delete output format
Declaration
protected virtual async Task<BusinessProcess> DeleteCoreAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Output format 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<BusinessProcess>
Business process |
Remarks
Deletes the output format specified by the ID. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
DeleteManyCoreAsync(OutputFormatDeleteManyRequest, CancellationToken)
Delete multiple output formats
Declaration
protected virtual async Task<BusinessProcess> DeleteManyCoreAsync(OutputFormatDeleteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatDeleteManyRequest
request
The request with output format 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 |
Remarks
Deletes the output formats specified by the IDs. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
GetAsync(String, CancellationToken)
Get output format
Declaration
public virtual async Task<OutputFormatDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Output format 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<OutputFormatDetail>
Represents an output format. |
Remarks
Gets the output format by the output format ID.
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple output formats
Declaration
public virtual async Task<ICollection<OutputFormatDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
Output format IDs to get information about. If this is omitted, all output formats in the system will be returned. |
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<OutputFormatDetail>>
Array of Represents an output format. |
Remarks
Gets multiple output format details by the output format IDs. Can fetch maximum of 100 output formats at once.
ReadObjectResponseAsync<T>(Http.HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<OutputFormatClient.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<OutputFormatClient.ObjectResponseResult<T>>
|
Type Parameters
T
|
RenderFormatPreviewAsync(OutputFormatRenderPreviewRequest, CancellationToken)
Render output format preview
Declaration
public virtual async Task<FileResponse> RenderFormatPreviewAsync(OutputFormatRenderPreviewRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatRenderPreviewRequest
request
Information about the OutputFormat as well as which Content to use for the preview. |
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<FileResponse>
Rendered file |
Remarks
Request rendering of the given OutputFormat for a given content.
SetDownloadFileNamePatternsAsync(String, IDictionary<String, String>, CancellationToken)
Sets the download file name patterns for an output format
Declaration
public virtual async Task<BusinessProcess> SetDownloadFileNamePatternsAsync(string id, IDictionary<string, string> patterns, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of the output format. |
System.Collections.Generic.IDictionary<System.String, System.String>
patterns
Dictionary containing patterns per metadata language.
|
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 |
Remarks
This is allowed for both static and dynamic formats. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
SetDownloadFileNamePatternsManyAsync(OutputFormatDownloadFileNamePatternUpdateManyRequest, CancellationToken)
Sets the download file name patterns for multiple output formats
Declaration
public virtual async Task<BusinessProcess> SetDownloadFileNamePatternsManyAsync(OutputFormatDownloadFileNamePatternUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatDownloadFileNamePatternUpdateManyRequest
request
The request containing the patterns for each output format. |
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 |
Remarks
This is allowed for both static and dynamic formats. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
SetPermissionAsync(String, OutputFormatSetPermissionRequest, CancellationToken)
Updates permission-related settings for an output format
Declaration
public virtual async Task<BusinessProcess> SetPermissionAsync(string id, OutputFormatSetPermissionRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of the output format. |
OutputFormatSetPermissionRequest
request
The request containing the settings for the output format. |
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 |
Remarks
This is allowed for both static and dynamic formats. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
SetPermissionManyAsync(OutputFormatSetPermissionManyRequest, CancellationToken)
Updates permission-related settings for multiple output formats
Declaration
public virtual async Task<BusinessProcess> SetPermissionManyAsync(OutputFormatSetPermissionManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatSetPermissionManyRequest
request
The request containing the state changes for each output format. |
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 |
Remarks
This is allowed for both static and dynamic formats. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
SetXmpWritebackStateAsync(String, OutputFormatSetXmpWritebackStateRequest, CancellationToken)
Enables or disables XMP writeback for an output format
Declaration
public virtual async Task<BusinessProcess> SetXmpWritebackStateAsync(string id, OutputFormatSetXmpWritebackStateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of the output format. |
OutputFormatSetXmpWritebackStateRequest
request
The request containing the state to be set for the output format. |
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 |
Remarks
This is allowed for both static and dynamic formats.
However, enabling XMP writeback for Thumbnail formats or temporary formats is not allowed. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
SetXmpWritebackStateManyAsync(OutputFormatSetXmpWritebackStateManyRequest, CancellationToken)
Enables or disables XMP writeback for multiple output formats
Declaration
public virtual async Task<BusinessProcess> SetXmpWritebackStateManyAsync(OutputFormatSetXmpWritebackStateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatSetXmpWritebackStateManyRequest
request
The request containing the state changes for each output format. |
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 |
Remarks
This is allowed for both static and dynamic formats.
However, enabling XMP writeback for Thumbnail formats or temporary formats is not allowed. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
UpdateCoreAsync(String, OutputFormatEditable, CancellationToken)
Update output format
Declaration
protected virtual async Task<BusinessProcess> UpdateCoreAsync(string id, OutputFormatEditable request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
Output format ID. |
OutputFormatEditable
request
Request containing information needed to update the output format. |
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 |
Remarks
Updates the output format specified by the ID and based on supplied request. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
UpdateManyCoreAsync(OutputFormatUpdateManyRequest, CancellationToken)
Update multiple output formats
Declaration
protected virtual async Task<BusinessProcess> UpdateManyCoreAsync(OutputFormatUpdateManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatUpdateManyRequest
request
Request containing information needed to update the output format. |
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 |
Remarks
Updates the output formats 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.