Class ServiceDescriptionTests

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

public class ServiceDescriptionTests : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

ServiceDescriptionTests

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

HtmlTestClientRelationLink

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

public string HtmlTestClientRelationLink { get; }

Property Value

Type	Description
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

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

QueryStringRelationLink

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

public string QueryStringRelationLink { get; }

Property Value

Type	Description
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”.

public string ReflectDialogQueryRelationLink { get; }

Property Value

Type	Description
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”.

public string ReflectStampPlacementRelationLink { get; }

Property Value

Type	Description
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”.

public Stream GetStreamFromHtmlTestClientRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromHtmlTestClientRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromHtmlTestClientRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<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.

public Task<DeserializedHttpResponse<Stream>> GetStreamFromHtmlTestClientRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

public Stream GetStreamFromQueryStringRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromQueryStringRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromQueryStringRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<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.

public Task<DeserializedHttpResponse<Stream>> GetStreamFromQueryStringRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

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.

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

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

Parameters

Type	Name	Description
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
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”.

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.

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

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

Parameters

Type	Name	Description
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
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.

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.