Class ShareClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ShareClient : ClientBase, IShareClientConstructors
ShareClient(IPictureparkServiceSettings, HttpClient)
Declaration
public ShareClient(IPictureparkServiceSettings configuration, HttpClient httpClient)Parameters
| IPictureparkServiceSettings configuration |
| HttpClient httpClient |
Properties
JsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }Property Value
| JsonSerializerSettings |
ReadResponseAsString
Methods
AggregateAsync(ShareAggregationRequest, CancellationToken)
Aggregate
Declaration
public virtual Task<ObjectAggregationResult> AggregateAsync(ShareAggregationRequest request, CancellationToken cancellationToken = default)Parameters
|
ShareAggregationRequest
request
Aggregation request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ObjectAggregationResult>
Share aggregation result |
Implements
Remarks
Aggregates shares either created by or sent to current user.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
CreateAsync(ShareBaseCreateRequest, CancellationToken)
Create
Declaration
public virtual Task<BusinessProcess> CreateAsync(ShareBaseCreateRequest request, CancellationToken cancellationToken = default)Parameters
|
ShareBaseCreateRequest
request
Polymorphic create contract. Use either ShareBasicCreateRequest or ShareEmbedCreateRequest |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
BusinessProcess |
Implements
Remarks
Create a new share (basic or embed). The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
|
PictureparkForbiddenException
Forbidden |
|
PermissionValidationException
No permission to share |
|
PictureparkNotFoundException
Entity not found |
|
ContentNotFoundException
Content could not be found |
CreateShareSelectionDownloadLinkAsync(string, ShareDownloadRequest, CancellationToken)
Download selection of a share
Declaration
public virtual Task<DownloadLink> CreateShareSelectionDownloadLinkAsync(string token, ShareDownloadRequest request, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
ShareDownloadRequest
request
Share download request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<DownloadLink>
DownloadLink |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DeleteManyAsync(ShareDeleteManyRequest, CancellationToken)
Delete multiple shares
Declaration
public virtual Task<BusinessProcess> DeleteManyAsync(ShareDeleteManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ShareDeleteManyRequest
request
A delete many request containing the ids of the shares to delete. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
BusinessProcess |
Implements
Remarks
Deletes multiple shares. Returns a business process which will hold a batch response detail containing information about successful and failed rows. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DownloadAsync(string, int?, int?, string, CancellationToken)
Download shared outputs
Declaration
public virtual Task<FileResponse> DownloadAsync(string token, int? width = null, int? height = null, string range = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
int?
width
Optional width in pixels to resize image |
|
int?
height
Optional height in pixels to resize image |
|
string
range
The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000) |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<FileResponse> |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DownloadDisplayContentOutputsAsync(string, string, string, CancellationToken)
Download shared display content outputs
Declaration
public virtual Task<FileResponse> DownloadDisplayContentOutputsAsync(string token, string contentId, string outputFormatId, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
contentId
The content id |
|
string
outputFormatId
Id of the output format |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<FileResponse> |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DownloadSingleContentAsync(string, string, string, int?, int?, string, CancellationToken)
Download shared output
Declaration
public virtual Task<FileResponse> DownloadSingleContentAsync(string token, string contentId, string outputFormatId, int? width = null, int? height = null, string range = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
contentId
The content id |
|
string
outputFormatId
The output format id |
|
int?
width
Optional width in pixels to resize image |
|
int?
height
Optional height in pixels to resize image |
|
string
range
The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000) |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<FileResponse> |
Implements
Remarks
Download single content in a specific output format (or automatically determined format if none is specified). To resize images on download specify target width & height. To download only a portion of the file, specify the range parameter.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DownloadWithContentIdAsync(string, string, int?, int?, string, CancellationToken)
Download shared outputs
Declaration
public Task<FileResponse> DownloadWithContentIdAsync(string token, string contentId, int? width = null, int? height = null, string range = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
contentId
The content id |
|
int?
width
Optional width in pixels to resize image |
|
int?
height
Optional height in pixels to resize image |
|
string
range
The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000) |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<FileResponse> |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkException
Internal server error |
DownloadWithConversionPresetAsync(string, string, string, CancellationToken)
Download shared outputs
Declaration
public virtual Task<FileResponse> DownloadWithConversionPresetAsync(string token, string conversionPreset, string range = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
conversionPreset
Image editing specification |
|
string
range
The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000) |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<FileResponse> |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DownloadWithOutputFormatIdAsync(string, string, string, int?, int?, string, CancellationToken)
Download shared outputs
Declaration
public Task<FileResponse> DownloadWithOutputFormatIdAsync(string token, string contentId, string outputFormatId, int? width = null, int? height = null, string range = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
contentId
The content id |
|
string
outputFormatId
The output format id |
|
int?
width
Optional width in pixels to resize image |
|
int?
height
Optional height in pixels to resize image |
|
string
range
The range of bytes to download (http range header): bytes={from}-{to} (e.g. bytes=0-100000) |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task<FileResponse> |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkException
Internal server error |
GetAsync(string, IEnumerable<ShareResolveBehavior>, int?, CancellationToken)
Get
Declaration
public virtual Task<ShareDetail> GetAsync(string id, IEnumerable<ShareResolveBehavior> resolveBehaviors = null, int? contentResolveLimit = null, CancellationToken cancellationToken = default)Parameters
|
string
id
Share Id (not token, use GetShareJson to get share by token) |
|
IEnumerable<ShareResolveBehavior>
resolveBehaviors
List of enums that control which parts of the share are resolved and returned. |
|
int?
contentResolveLimit
Optional limit the number of contents to resolve. Use a lower value for higher performance. If nothing is specified, everything is resolved. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ShareDetail>
Share detail |
Implements
Remarks
Get share by id (basic or embed).
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
|
PictureparkNotFoundException
Entity not found |
|
ShareNotFoundException
Share could not be found |
GetContentsInShareAsync(string, int?, string, CancellationToken)
Get contents in share
Declaration
public virtual Task<ShareContentDetailResult> GetContentsInShareAsync(string id, int? limit = null, string pageToken = null, CancellationToken cancellationToken = default)Parameters
|
string
id
Share Id |
|
int?
limit
Number of contents to return |
|
string
pageToken
PageToken to page over contents |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ShareContentDetailResult>
ShareContentDetailResult |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetOutputsInShareAsync(string, CancellationToken)
Get shared outputs
Declaration
public virtual Task<ShareOutputsResult> GetOutputsInShareAsync(string token, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ShareOutputsResult>
List of OutputResolveResult |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetShareContentsAsync(string, string, int?, string, CancellationToken)
Get share contents
Declaration
public virtual Task<ShareContentDetailResult> GetShareContentsAsync(string token, string lang = null, int? limit = null, string pageToken = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
lang
Language code |
|
int?
limit
Number of contents to return |
|
string
pageToken
PageToken to page over contents |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ShareContentDetailResult>
ShareContentDetailResult |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetShareJsonAsync(string, string, IEnumerable<ShareResolveBehavior>, int?, CancellationToken)
Get share json
Declaration
public virtual Task<ShareDetail> GetShareJsonAsync(string token, string lang = null, IEnumerable<ShareResolveBehavior> resolveBehaviors = null, int? contentResolveLimit = null, CancellationToken cancellationToken = default)Parameters
|
string
token
Share token |
|
string
lang
Language code |
|
IEnumerable<ShareResolveBehavior>
resolveBehaviors
List of enums that control which parts of the share are resolved and returned. |
|
int?
contentResolveLimit
Optional limit the number of contents to resolve. Use a lower value for higher performance. If nothing is specified, everything is resolved. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ShareDetail>
ShareDetail |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)
Declaration
protected virtual Task<ShareClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)Parameters
| HttpResponseMessage response |
| IReadOnlyDictionary<string, IEnumerable<string>> headers |
| CancellationToken cancellationToken |
Returns
| Task<ShareClient.ObjectResponseResult<T>> |
Type Parameters
| T |
RevokeAsync(ShareRevokeManyRequest, CancellationToken)
Revokes multiple shares
Declaration
public virtual Task<BusinessProcess> RevokeAsync(ShareRevokeManyRequest request, CancellationToken cancellationToken = default)Parameters
|
ShareRevokeManyRequest
request
A revoke many request containing the ids of the shares to revoke. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
BusinessProcess |
Implements
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
SearchAsync(ShareSearchRequest, CancellationToken)
Search
Declaration
public virtual Task<ShareSearchResult> SearchAsync(ShareSearchRequest request, CancellationToken cancellationToken = default)Parameters
|
ShareSearchRequest
request
Search request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ShareSearchResult>
Share search result |
Implements
Remarks
Search shares either created by or sent to current user.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
UpdateAsync(string, ShareBaseUpdateRequest, CancellationToken)
Update
Declaration
public virtual Task<BusinessProcess> UpdateAsync(string id, ShareBaseUpdateRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
The share id. |
|
ShareBaseUpdateRequest
request
The share update request. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
BusinessProcess |
Implements
Remarks
Updates a single share. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
|
PictureparkValidationException
Validation exception |
|
BusinessProcessLifeCycleNotHitException
A server side error occurred. |