Class BpwService

Business workflow server service definition.

Inheritance

System.Object

BpwService

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class BpwService : IRelationsWithProxy

Properties

CommonUserRelationLink

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

Declaration

public string CommonUserRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

ControllerRelationLink

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

Declaration

public string ControllerRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

OwnSimpleWorkflowsRelationLink

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

Declaration

public string OwnSimpleWorkflowsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

SettingsRelationLink

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

Declaration

public string SettingsRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

SimpleTasksRelationLink

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

Declaration

public string SimpleTasksRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetBpwSettingsFromSettingsRelation()

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

Declaration

public BpwSettings GetBpwSettingsFromSettingsRelation()

Returns

Type	Description
BpwSettings	The content of the response.

GetBpwSettingsFromSettingsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BpwSettings>> GetBpwSettingsFromSettingsRelationAsync()

Returns

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

Remarks

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

GetBpwSettingsFromSettingsRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetOwnSimpleWorkflowsDataFromOwnSimpleWorkflowsRelation()

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

Declaration

public OwnSimpleWorkflowsData GetOwnSimpleWorkflowsDataFromOwnSimpleWorkflowsRelation()

Returns

Type	Description
OwnSimpleWorkflowsData	The content of the response.

GetOwnSimpleWorkflowsDataFromOwnSimpleWorkflowsRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<OwnSimpleWorkflowsData>> GetOwnSimpleWorkflowsDataFromOwnSimpleWorkflowsRelationAsync()

Returns

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

Remarks

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

GetOwnSimpleWorkflowsDataFromOwnSimpleWorkflowsRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetSimpleTasksDataFromSimpleTasksRelation()

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

Declaration

public SimpleTasksData GetSimpleTasksDataFromSimpleTasksRelation()

Returns

Type	Description
SimpleTasksData	The content of the response.

GetSimpleTasksDataFromSimpleTasksRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<SimpleTasksData>> GetSimpleTasksDataFromSimpleTasksRelationAsync()

Returns

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

Remarks

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

GetSimpleTasksDataFromSimpleTasksRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetUserWorkflowsFromCommonUserRelation()

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

Declaration

public UserWorkflows GetUserWorkflowsFromCommonUserRelation()

Returns

Type	Description
UserWorkflows	The content of the response.

GetUserWorkflowsFromCommonUserRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<UserWorkflows>> GetUserWorkflowsFromCommonUserRelationAsync()

Returns

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

Remarks

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

GetUserWorkflowsFromCommonUserRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

GetUserWorkflowsFromControllerRelation()

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

Declaration

public UserWorkflows GetUserWorkflowsFromControllerRelation()

Returns

Type	Description
UserWorkflows	The content of the response.

GetUserWorkflowsFromControllerRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<UserWorkflows>> GetUserWorkflowsFromControllerRelationAsync()

Returns

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

Remarks

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

GetUserWorkflowsFromControllerRelationAsync(System.Threading.CancellationToken)

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

Declaration

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

Remarks

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

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.