Class ServiceDescriptionTests

Inheritance

System.Object

ServiceDescriptionTests

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class ServiceDescriptionTests : IRelationsWithProxy

Properties

HtmlTestClientRelationLink

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

Declaration

public string HtmlTestClientRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

QueryStringRelationLink

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

Declaration

public string QueryStringRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

ReflectDialogQueryRelationLink

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

Declaration

public string ReflectDialogQueryRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

ReflectStampPlacementRelationLink

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

Declaration

public string ReflectStampPlacementRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetStreamFromHtmlTestClientRelation()

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

Declaration

public Stream GetStreamFromHtmlTestClientRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromHtmlTestClientRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<Stream>> GetStreamFromHtmlTestClientRelationAsync()

Returns

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

Remarks

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

GetStreamFromHtmlTestClientRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<Stream>> GetStreamFromHtmlTestClientRelationAsync(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<System.IO.Stream>>	A task which runs the request.

Remarks

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

GetStreamFromQueryStringRelation()

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

Declaration

public Stream GetStreamFromQueryStringRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromQueryStringRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<Stream>> GetStreamFromQueryStringRelationAsync()

Returns

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

Remarks

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

GetStreamFromQueryStringRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<Stream>> GetStreamFromQueryStringRelationAsync(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<System.IO.Stream>>	A task which runs the request.

Remarks

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

PostToReflectDialogQueryRelationForDialogExpression(DialogExpression)

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

Declaration

public DialogExpression PostToReflectDialogQueryRelationForDialogExpression(DialogExpression dataToSend)

Parameters

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

Returns

Type	Description
DialogExpression	The content of the response.

PostToReflectDialogQueryRelationForDialogExpressionAsync(DialogExpression)

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

Declaration

public Task<DeserializedHttpResponse<DialogExpression>> PostToReflectDialogQueryRelationForDialogExpressionAsync(DialogExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToReflectDialogQueryRelationForDialogExpressionAsync(CancellationToken, DialogExpression)

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

Declaration

public Task<DeserializedHttpResponse<DialogExpression>> PostToReflectDialogQueryRelationForDialogExpressionAsync(CancellationToken cancellationToken, DialogExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToReflectStampPlacementRelationForStampPlacement(StampPlacement)

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

Declaration

public StampPlacement PostToReflectStampPlacementRelationForStampPlacement(StampPlacement dataToSend)

Parameters

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

Returns

Type	Description
StampPlacement	The content of the response.

PostToReflectStampPlacementRelationForStampPlacementAsync(StampPlacement)

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

Declaration

public Task<DeserializedHttpResponse<StampPlacement>> PostToReflectStampPlacementRelationForStampPlacementAsync(StampPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToReflectStampPlacementRelationForStampPlacementAsync(CancellationToken, StampPlacement)

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

Declaration

public Task<DeserializedHttpResponse<StampPlacement>> PostToReflectStampPlacementRelationForStampPlacementAsync(CancellationToken cancellationToken, StampPlacement dataToSend)

Parameters

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

Returns

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

Remarks

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

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 System.Net.Http.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.