Class DocumentLink

Define a query that link one document to another document from same or different file cabinet

Inheritance

System.Object

DocumentLink

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class DocumentLink : IRelationsWithProxy

Constructors

DocumentLink()

Creates a new instance of this class

Declaration

public DocumentLink()

Properties

Id

Identity of the document link

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

IsInvalid

Indicates whether the document relation is invalid

Declaration

public bool IsInvalid { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

Name of the document link

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ResultDialogRelationLink

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

Declaration

public string ResultDialogRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “resultDialog” 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.

ResultRelationLink

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

Declaration

public string ResultRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “result” 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.

TargetFileCabinet

File cabinet that the document is linked to

Declaration

public string TargetFileCabinet { get; set; }

Property Value

Type	Description
System.String

TargetResultList

Identity of the result list that will be used to show the linked documents

Declaration

public string TargetResultList { get; set; }

Property Value

Type	Description
System.String

Methods

GetDialogFromResultDialogRelation()

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

Declaration

public Dialog GetDialogFromResultDialogRelation()

Returns

Type	Description
Dialog	The content of the response.

GetDialogFromResultDialogRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromResultDialogRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>>	A task which runs the request.

Remarks

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

GetDialogFromResultDialogRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<Dialog>> GetDialogFromResultDialogRelationAsync(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<Dialog>>	A task which runs the request.

Remarks

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

GetDocumentsQueryResultFromResultRelation()

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

Declaration

public DocumentsQueryResult GetDocumentsQueryResultFromResultRelation()

Returns

Type	Description
DocumentsQueryResult	The content of the response.

GetDocumentsQueryResultFromResultRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromResultRelationAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

GetDocumentsQueryResultFromResultRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> GetDocumentsQueryResultFromResultRelationAsync(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<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

PostToResultRelationForDocumentsQueryResult(DocumentLinkExpressionQuery)

Calls the HTTP Post method on the link for the relation “result”.

Declaration

public DocumentsQueryResult PostToResultRelationForDocumentsQueryResult(DocumentLinkExpressionQuery dataToSend)

Parameters

Type	Name	Description
DocumentLinkExpressionQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
DocumentsQueryResult	The content of the response.

PostToResultRelationForDocumentsQueryResult(ResultListQuery)

Calls the HTTP Post method on the link for the relation “result”.

Declaration

public DocumentsQueryResult PostToResultRelationForDocumentsQueryResult(ResultListQuery dataToSend)

Parameters

Type	Name	Description
ResultListQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
DocumentsQueryResult	The content of the response.

PostToResultRelationForDocumentsQueryResultAsync(DocumentLinkExpressionQuery)

Calls the HTTP Post method on the link for the relation “result” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToResultRelationForDocumentsQueryResultAsync(DocumentLinkExpressionQuery dataToSend)

Parameters

Type	Name	Description
DocumentLinkExpressionQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

PostToResultRelationForDocumentsQueryResultAsync(ResultListQuery)

Calls the HTTP Post method on the link for the relation “result” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToResultRelationForDocumentsQueryResultAsync(ResultListQuery dataToSend)

Parameters

Type	Name	Description
ResultListQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

PostToResultRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, DocumentLinkExpressionQuery)

Calls the HTTP Post method on the link for the relation “result” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToResultRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken cancellationToken, DocumentLinkExpressionQuery dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
DocumentLinkExpressionQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

PostToResultRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken, ResultListQuery)

Calls the HTTP Post method on the link for the relation “result” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>> PostToResultRelationForDocumentsQueryResultAsync(System.Threading.CancellationToken cancellationToken, ResultListQuery dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
ResultListQuery	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.Threading.Tasks.Task<DeserializedHttpResponse<DocumentsQueryResult>>	A task which runs the request.

Remarks

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

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 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.