Class Decision

Namespace
DocuWare.Platform.Bpw.Schemas
Assembly
DocuWare.Platform.ServerClient.dll

public class Decision : IRelationsWithProxy
Inheritance
Decision

Properties

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

public string ConfirmRelationLink { get; }

Property Value

TypeDescription
String

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.

DecisionLabel

public string DecisionLabel { get; set; }

Property Value

TypeDescription
String

Description

public string Description { get; set; }

Property Value

TypeDescription
String

FormField

public List<Field> FormField { get; set; }

Property Value

TypeDescription
List<Field>

Forms

public List<BaseForm> Forms { get; set; }

Property Value

TypeDescription
List<BaseForm>

Id

public string Id { get; set; }

Property Value

TypeDescription
String

IsDefaultDecision

public bool IsDefaultDecision { get; set; }

Property Value

TypeDescription
Boolean
public Link[] Links { get; set; }

Property Value

TypeDescription
Link[]

StampColor

public string StampColor { get; set; }

Property Value

TypeDescription
String

Methods

PostToConfirmRelationForString(DecisionData)

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

public string PostToConfirmRelationForString(DecisionData dataToSend)

Parameters

TypeNameDescription
DecisionDatadataToSend

The data to send. This data is written into the request body.

Returns

TypeDescription
String

The content of the response.

PostToConfirmRelationForStringAsync(DecisionData)

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

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(DecisionData dataToSend)

Parameters

TypeNameDescription
DecisionDatadataToSend

The data to send. This data is written into the request body.

Returns

TypeDescription
System.Threading.Tasks.Task<DeserializedHttpResponse<String>>

A task which runs the request.

Remarks

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

PostToConfirmRelationForStringAsync(System.Threading.CancellationToken, DecisionData)

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

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(System.Threading.CancellationToken cancellationToken, DecisionData dataToSend)

Parameters

TypeNameDescription
System.Threading.CancellationTokencancellationToken

The cancellation token to cancel the request.

DecisionDatadataToSend

The data to send. This data is written into the request body.

Returns

TypeDescription
System.Threading.Tasks.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

TypeNameDescription
HttpClientProxyproxy

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.