Class DocumentHistoryClient

Inheritance

object

ClientBase

DocumentHistoryClient

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 DocumentHistoryClient : ClientBase, IDocumentHistoryClient

Constructors

DocumentHistoryClient(IPictureparkServiceSettings, HttpClient)

Declaration

public DocumentHistoryClient(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

CompareWithCurrentAsync(string, string, long?, CancellationToken)

Compare with current

Declaration

public virtual Task<DocumentHistoryDifference> CompareWithCurrentAsync(string documentType, string documentId, long? version = null, CancellationToken cancellationToken = default)

Parameters

string documentType The type of the document (e.g. Content).

string documentId The ID of the document (e.g. contentId).

long? version The version of the document to compare with.

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

Returns

Task<DocumentHistoryDifference> Document history difference.

Implements

IDocumentHistoryClient.CompareWithCurrentAsync(string, string, long?, CancellationToken)

Remarks

Compare the current version of a document with the requested version and get the differences.

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

CompareWithVersionAsync(string, string, long, long?, CancellationToken)

Compare with version

Declaration

public virtual Task<DocumentHistoryDifference> CompareWithVersionAsync(string documentType, string documentId, long documentVersion, long? version = null, CancellationToken cancellationToken = default)

Parameters

string documentType The type of the document (e.g. Content).

string documentId The ID of the document (e.g. contentId).

long documentVersion The version of the document to use for the comparison.

long? version The version of the document to compare with.

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

Returns

Task<DocumentHistoryDifference> Document history difference

Implements

IDocumentHistoryClient.CompareWithVersionAsync(string, string, long, long?, CancellationToken)

Remarks

Compare a specific version of a document with another version and get the differences.

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

GetCurrentAsync(string, string, CancellationToken)

Get current

Declaration

public virtual Task<DocumentHistory> GetCurrentAsync(string documentType, string documentId, CancellationToken cancellationToken = default)

Parameters

string documentType The type of the document (e.g. Content).

string documentId The ID of the document (e.g. contentId).

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

Returns

Task<DocumentHistory> Document history item

Implements

IDocumentHistoryClient.GetCurrentAsync(string, string, CancellationToken)

Remarks

Gets the current version of a document.

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

GetVersionAsync(string, string, long, CancellationToken)

Get version

Declaration

public virtual Task<DocumentHistory> GetVersionAsync(string documentType, string documentId, long documentVersion, CancellationToken cancellationToken = default)

Parameters

string documentType The type of the document (e.g. Content).

string documentId The ID of the document (e.g. contentId).

long documentVersion The version of the document.

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

Returns

Task<DocumentHistory> Document history item

Implements

IDocumentHistoryClient.GetVersionAsync(string, string, long, CancellationToken)

Remarks

Gets a specific version of a document.

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

Type Parameters

T

SearchAsync(DocumentHistorySearchRequest, CancellationToken)

Search

Declaration

public virtual Task<DocumentHistorySearchResult> SearchAsync(DocumentHistorySearchRequest request, CancellationToken cancellationToken = default)

Parameters

DocumentHistorySearchRequest request The document history search request.

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

Returns

Task<DocumentHistorySearchResult> Document history search result.

Implements

IDocumentHistoryClient.SearchAsync(DocumentHistorySearchRequest, CancellationToken)

Remarks

Search the document history as specified in the search request.

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