Class RequestDecision

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

A request decision for a common user.

public class RequestDecision : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

RequestDecision

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

ConfirmRelationLink

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

public string ConfirmRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Id

Sequential order number of the decision in the request. Decision identifier.

public string Id { get; set; }

Property Value

Type	Description
string

Label

Label of the decision.

public string Label { get; set; }

Property Value

Type	Description
string

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

SelfRelationLink

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

public string SelfRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

GetRequestDecisionFromSelfRelation()

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

public RequestDecision GetRequestDecisionFromSelfRelation()

Returns

Type	Description
RequestDecision	The content of the response.

GetRequestDecisionFromSelfRelationAsync()

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

public Task<DeserializedHttpResponse<RequestDecision>> GetRequestDecisionFromSelfRelationAsync()

Returns

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

Remarks

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

GetRequestDecisionFromSelfRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<RequestDecision>> GetRequestDecisionFromSelfRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToConfirmRelationForString(RequestConfirmedData)

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

public string PostToConfirmRelationForString(RequestConfirmedData dataToSend)

Parameters

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

Returns

Type	Description
string	The content of the response.

PostToConfirmRelationForStringAsync(RequestConfirmedData)

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

public Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(RequestConfirmedData dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToConfirmRelationForStringAsync(CancellationToken, RequestConfirmedData)

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

public Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(CancellationToken cancellationToken, RequestConfirmedData dataToSend)

Parameters

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

Returns

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

Remarks

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

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.