Class SimpleWorkflowDefinitionsData

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

public class SimpleWorkflowDefinitionsData : IRelationsWithProxy

Inheritance: Object

SimpleWorkflowDefinitionsData

Properties

CreateRelationLink

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

public string CreateRelationLink { get; }

Property Value

Type	Description
String

Remarks

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

DeleteRelationLink

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

public string DeleteRelationLink { get; }

Property Value

Type	Description
String

Remarks

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

GetRelationLink

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

public string GetRelationLink { get; }

Property Value

Type	Description
String

Remarks

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

Methods

GetSimpleWorkflowDatasFromGetRelation()

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

public SimpleWorkflowDatas GetSimpleWorkflowDatasFromGetRelation()

Returns

Type	Description
SimpleWorkflowDatas	The content of the response.

GetSimpleWorkflowDatasFromGetRelationAsync()

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

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleWorkflowDatas>> GetSimpleWorkflowDatasFromGetRelationAsync()

Returns

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

Remarks

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

GetSimpleWorkflowDatasFromGetRelationAsync(System.Threading.CancellationToken)

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

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleWorkflowDatas>> GetSimpleWorkflowDatasFromGetRelationAsync(System.Threading.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<SimpleWorkflowDatas>>	A task which runs the request.

Remarks

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

PostToCreateRelationForString(SimpleWorkflowData)

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

public string PostToCreateRelationForString(SimpleWorkflowData dataToSend)

Parameters

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

Returns

Type	Description
String	The content of the response.

PostToCreateRelationForStringAsync(SimpleWorkflowData)

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

public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToCreateRelationForStringAsync(SimpleWorkflowData dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToCreateRelationForStringAsync(System.Threading.CancellationToken, SimpleWorkflowData)

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

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

Parameters

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

Returns

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

Remarks

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

PostToDeleteRelationForString(String)

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

public string PostToDeleteRelationForString(string dataToSend)

Parameters

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

Returns

Type	Description
String	The content of the response.

PostToDeleteRelationForStringAsync(String)

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

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

Parameters

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

Returns

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

Remarks

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

PostToDeleteRelationForStringAsync(System.Threading.CancellationToken, String)

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

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

Parameters

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

Returns

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

Remarks

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

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