Interface IOutputFormatClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IOutputFormatClient
Methods
CreateAsync(OutputFormat, Nullable<TimeSpan>, CancellationToken)
Create output format
Declaration
Task<OutputFormatOperationResult> CreateAsync(OutputFormat request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormat
request
The request containing information needed to create new output format. |
System.Nullable<TimeSpan>
timeout
Timeout for business process completion |
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<OutputFormatOperationResult>
Output format |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
CreateManyAsync(OutputFormatCreateManyRequest, Nullable<TimeSpan>, CancellationToken)
Create multiple output formats
Declaration
Task<OutputFormatBatchOperationResult> CreateManyAsync(OutputFormatCreateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatCreateManyRequest
request
The request containing information needed to create new output formats. |
System.Nullable<TimeSpan>
timeout
Timeout for business process completion |
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<OutputFormatBatchOperationResult>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
DeleteAsync(String, Nullable<TimeSpan>, CancellationToken)
Delete output format
Declaration
Task<OutputFormatDeleteResult> DeleteAsync(string id, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of the output format that should be deleted. |
System.Nullable<TimeSpan>
timeout
Timeout for business process completion |
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<OutputFormatDeleteResult>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
DeleteManyAsync(OutputFormatDeleteManyRequest, Nullable<TimeSpan>, CancellationToken)
Delete multiple output formats
Declaration
Task<OutputFormatBatchOperationResult> DeleteManyAsync(OutputFormatDeleteManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatDeleteManyRequest
request
The request with output formats IDs to delete. |
System.Nullable<TimeSpan>
timeout
Timeout for business process completion |
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<OutputFormatBatchOperationResult>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
GetAllAsync(CancellationToken)
Declaration
Task<ICollection<OutputFormatDetail>> GetAllAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken
cancellationToken
|
Returns
System.Threading.Tasks.Task<ICollection<OutputFormatDetail>>
|
GetAsync(String, CancellationToken)
Get output format
Declaration
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. |
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 output formats
Declaration
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. |
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 |
RenderFormatPreviewAsync(OutputFormatRenderPreviewRequest, CancellationToken)
Render output format preview
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SetDownloadFileNamePatternsAsync(String, IDictionary<String, String>, CancellationToken)
Sets the download file name patterns for an output format
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SetDownloadFileNamePatternsManyAsync(OutputFormatDownloadFileNamePatternUpdateManyRequest, CancellationToken)
Sets the download file name patterns for multiple output formats
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SetPermissionAsync(String, OutputFormatSetPermissionRequest, CancellationToken)
Updates permission-related settings for an output format
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SetPermissionManyAsync(OutputFormatSetPermissionManyRequest, CancellationToken)
Updates permission-related settings for multiple output formats
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SetXmpWritebackStateAsync(String, OutputFormatSetXmpWritebackStateRequest, CancellationToken)
Enables or disables XMP writeback for an output format
Declaration
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 |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SetXmpWritebackStateManyAsync(OutputFormatSetXmpWritebackStateManyRequest, CancellationToken)
Enables or disables XMP writeback for multiple output formats
Declaration
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 |
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, OutputFormatEditable, Nullable<TimeSpan>, CancellationToken)
Update output format
Declaration
Task<OutputFormatOperationResult> UpdateAsync(string id, OutputFormatEditable request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
ID of output format to update |
OutputFormatEditable
request
The request containing information needed to update the output format. |
System.Nullable<TimeSpan>
timeout
Timeout for business process completion |
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<OutputFormatOperationResult>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |
UpdateManyAsync(OutputFormatUpdateManyRequest, Nullable<TimeSpan>, CancellationToken)
Update multiple output formats
Declaration
Task<OutputFormatBatchOperationResult> UpdateManyAsync(OutputFormatUpdateManyRequest request, TimeSpan? timeout = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
OutputFormatUpdateManyRequest
request
The request containing information needed to update the output format. |
System.Nullable<TimeSpan>
timeout
Timeout for business process completion |
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<OutputFormatBatchOperationResult>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkException
Internal server error |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkValidationException
Validation exception |