Interface IDocumentHistoryClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IDocumentHistoryClient
Methods
CompareWithCurrentAsync(String, String, Nullable<Int64>, CancellationToken)
Compare with current
Declaration
Task<DocumentHistoryDifference> CompareWithCurrentAsync(string documentType, string documentId, long? version = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
documentType
The type of the document (e.g. Content). |
System.String
documentId
The ID of the document (e.g. contentId). |
System.Nullable<System.Int64>
version
The version of the document to compare with. |
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<DocumentHistoryDifference>
Document history difference. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CompareWithVersionAsync(String, String, Int64, Nullable<Int64>, CancellationToken)
Compare with version
Declaration
Task<DocumentHistoryDifference> CompareWithVersionAsync(string documentType, string documentId, long documentVersion, long? version = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
documentType
The type of the document (e.g. Content). |
System.String
documentId
The ID of the document (e.g. contentId). |
System.Int64
documentVersion
The version of the document to use for the comparison. |
System.Nullable<System.Int64>
version
The version of the document to compare with. |
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<DocumentHistoryDifference>
Document history difference |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetCurrentAsync(String, String, CancellationToken)
Get current
Declaration
Task<DocumentHistory> GetCurrentAsync(string documentType, string documentId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
documentType
The type of the document (e.g. Content). |
System.String
documentId
The ID of the document (e.g. contentId). |
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<DocumentHistory>
Document history item |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetVersionAsync(String, String, Int64, CancellationToken)
Get version
Declaration
Task<DocumentHistory> GetVersionAsync(string documentType, string documentId, long documentVersion, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
documentType
The type of the document (e.g. Content). |
System.String
documentId
The ID of the document (e.g. contentId). |
System.Int64
documentVersion
The version of the document. |
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<DocumentHistory>
Document history item |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SearchAsync(DocumentHistorySearchRequest, CancellationToken)
Search
Declaration
Task<DocumentHistorySearchResult> SearchAsync(DocumentHistorySearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
DocumentHistorySearchRequest
request
The document history search request. |
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<DocumentHistorySearchResult>
Document history search result. |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |