Class StatisticClient

Inheritance

object

ClientBase

StatisticClient

Inherited Members

ClientBase.BaseUrl

ClientBase.CustomerAlias

ClientBase.CreateHttpRequestMessageAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class StatisticClient : ClientBase, IStatisticClient

Constructors

StatisticClient(IPictureparkServiceSettings, HttpClient)

Declaration

public StatisticClient(IPictureparkServiceSettings configuration, HttpClient httpClient)

Parameters

IPictureparkServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

AddContentEventsAsync(AddContentEventsRequest, CancellationToken)

Add content events

Declaration

public virtual Task<BusinessProcess> AddContentEventsAsync(AddContentEventsRequest request, CancellationToken cancellationToken = default)

Parameters

AddContentEventsRequest request Request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IStatisticClient.AddContentEventsAsync(AddContentEventsRequest, CancellationToken)

Remarks

Supply additional events from external sources. 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

ExportContentStatisticsAsync(ExportContentStatisticsRequest, CancellationToken)

Export content statistics

Declaration

public virtual Task<BusinessProcess> ExportContentStatisticsAsync(ExportContentStatisticsRequest request, CancellationToken cancellationToken = default)

Parameters

ExportContentStatisticsRequest request Request

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BusinessProcess> Business process

Implements

IStatisticClient.ExportContentStatisticsAsync(ExportContentStatisticsRequest, CancellationToken)

Remarks

Trigger export of statistical data for contents for further processing. 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

GetSingleContentStatisticsAsync(string, IEnumerable<TimeSpan>, CancellationToken)

Retrieve single content statistics

Declaration

public virtual Task<ContentStatisticsAggregated> GetSingleContentStatisticsAsync(string contentId, IEnumerable<TimeSpan> timeFrames = null, CancellationToken cancellationToken = default)

Parameters

string contentId Id of Content

IEnumerable<TimeSpan> timeFrames Optionally aggregate data for given time frames

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ContentStatisticsAggregated>

Implements

IStatisticClient.GetSingleContentStatisticsAsync(string, IEnumerable<TimeSpan>, CancellationToken)

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<StatisticClient.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<StatisticClient.ObjectResponseResult<T>>

Type Parameters

T

ResolveDownloadLinkAsync(string, CancellationToken)

Resolve download link

Declaration

public virtual Task<DownloadLink> ResolveDownloadLinkAsync(string referenceId, CancellationToken cancellationToken = default)

Parameters

string referenceId Reference id

CancellationToken cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DownloadLink> Download link information

Implements

IStatisticClient.ResolveDownloadLinkAsync(string, CancellationToken)

Remarks

Resolve an actual Url to download exported file from referenceId found on completed BusinessProcess.

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