Interface IDocumentHistoryClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IDocumentHistoryClient

Methods

CompareWithCurrentAsync(string, string, long?, CancellationToken)

Compare with current

Declaration

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.

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

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

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

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

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

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

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

SearchAsync(DocumentHistorySearchRequest, CancellationToken)

Search

Declaration

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.

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