Class DocumentAuditInformation
Defines auditing information for a document.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class DocumentAuditInformation : IRelationsWithProxy
Properties
Events
Gets or sets a list of document auditing events.
Declaration
public List<DocumentAuditEvent> Events { get; set; }
Property Value
Type | Description |
---|---|
List<DocumentAuditEvent> |
FirstRelationLink
Gets the Uri of the link for the relation “first”.
Declaration
public string FirstRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “first” if it exists, or
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
NextRelationLink
Gets the Uri of the link for the relation “next”.
Declaration
public string NextRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “next” if it exists, or
PrevRelationLink
Gets the Uri of the link for the relation “prev”.
Declaration
public string PrevRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “prev” if it exists, or
Methods
GetDocumentAuditInformationFromFirstRelation()
Calls the HTTP Get method on the link for the relation “first”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromFirstRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetDocumentAuditInformationFromFirstRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromFirstRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromNextRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetDocumentAuditInformationFromNextRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromNextRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.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”.
Declaration
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.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromPrevRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetDocumentAuditInformationFromPrevRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentAuditInformation>> GetDocumentAuditInformationFromPrevRelationAsync(System.Threading.CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.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.
Declaration
public void SetProxy(HttpClientProxy proxy)
Parameters
Type | Name | Description |
---|---|---|
HttpClientProxy | proxy | The |
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.