Class Decision

Inheritance
System.Object
Decision
Namespace: DocuWare.Platform.Bpw.Schemas
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class Decision : IRelationsWithProxy

Properties

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

Declaration
public string ConfirmRelationLink { get; }
Property Value
Type Description
System.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

Declaration
public string DecisionLabel { get; set; }
Property Value
Type Description
System.String

Description

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

FormField

Declaration
public List<Field> FormField { get; set; }
Property Value
Type Description
List<Field>

Forms

Declaration
public List<BaseForm> Forms { get; set; }
Property Value
Type Description
List<BaseForm>

Id

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

IsDefaultDecision

Declaration
public bool IsDefaultDecision { get; set; }
Property Value
Type Description
System.Boolean
Declaration
public Link[] Links { get; set; }
Property Value
Type Description
Link[]

StampColor

Declaration
public string StampColor { get; set; }
Property Value
Type Description
System.String

Methods

PostToConfirmRelationForString(DecisionData)

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

Declaration
public string PostToConfirmRelationForString(DecisionData dataToSend)
Parameters
Type Name Description
DecisionData dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.String

The content of the response.

PostToConfirmRelationForStringAsync(DecisionData)

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

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(DecisionData dataToSend)
Parameters
Type Name Description
DecisionData dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.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.

Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToConfirmRelationForStringAsync(System.Threading.CancellationToken cancellationToken, DecisionData dataToSend)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The cancellation token to cancel the request.
DecisionData dataToSend

The data to send. This data is written into the request body.
Returns
Type Description
System.Threading.Tasks.Task<DeserializedHttpResponse<System.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.

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.