Class DocumentAuditInformation

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Defines auditing information for a document.

public class DocumentAuditInformation : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

DocumentAuditInformation

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Events

Gets or sets a list of document auditing events.

public List<DocumentAuditEvent> Events { get; set; }

Property Value

Type	Description
List<DocumentAuditEvent>

FirstRelationLink

Gets the Uri of the link for the relation “first”.

public string FirstRelationLink { get; }

Property Value

Type	Description
string

Remarks

Returns the uri of the link for the relation “first” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

Gets the Uri of the link for the relation “next”.

public string NextRelationLink { get; }

Property Value

Type	Description
string

Remarks

Returns the uri of the link for the relation “next” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

PrevRelationLink

Gets the Uri of the link for the relation “prev”.

public string PrevRelationLink { get; }

Property Value

Type	Description
string

Remarks

Returns the uri of the link for the relation “prev” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

Methods

GetDocumentAuditInformationFromFirstRelation()

Calls the HTTP Get method on the link for the relation “first”.

public DocumentAuditInformation GetDocumentAuditInformationFromFirstRelation()

Returns

Type	Description
DocumentAuditInformation	The content of the response.

GetDocumentAuditInformationFromFirstRelationAsync()

Calls the HTTP Get method on the link for the relation “first” asynchronously.

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromFirstRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

This method follows the link for the relation “first”.

GetDocumentAuditInformationFromFirstRelationAsync(CancellationToken)

Calls the HTTP Get method on the link for the relation “first” asynchronously.

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromFirstRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

This method follows the link for the relation “first”.

GetDocumentAuditInformationFromNextRelation()

Calls the HTTP Get method on the link for the relation “next”.

public DocumentAuditInformation GetDocumentAuditInformationFromNextRelation()

Returns

Type	Description
DocumentAuditInformation	The content of the response.

GetDocumentAuditInformationFromNextRelationAsync()

Calls the HTTP Get method on the link for the relation “next” asynchronously.

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromNextRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

GetDocumentAuditInformationFromNextRelationAsync(CancellationToken)

Calls the HTTP Get method on the link for the relation “next” asynchronously.

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromNextRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

GetDocumentAuditInformationFromPrevRelation()

Calls the HTTP Get method on the link for the relation “prev”.

public DocumentAuditInformation GetDocumentAuditInformationFromPrevRelation()

Returns

Type	Description
DocumentAuditInformation	The content of the response.

GetDocumentAuditInformationFromPrevRelationAsync()

Calls the HTTP Get method on the link for the relation “prev” asynchronously.

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromPrevRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

This method follows the link for the relation “prev”.

GetDocumentAuditInformationFromPrevRelationAsync(CancellationToken)

Calls the HTTP Get method on the link for the relation “prev” asynchronously.

public Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromPrevRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<DocumentAuditInformation>>	A task which runs the request.

Remarks

This method follows the link for the relation “prev”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The HttpClient instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.