Class BaseTaskOperations
Operations available for all users.
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class BaseTaskOperations : IRelationsWithProxy
Properties
HistoryRelationLink
Gets the Uri of the link for the relation “history”.
Declaration
public string HistoryRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “history” if it exists, or
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
MaintenanceSelfRelationLink
Gets the Uri of the link for the relation “maintenanceSelf”.
Declaration
public string MaintenanceSelfRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “maintenanceSelf” if it exists, or
ReassignedTaskRelationLink
Gets the Uri of the link for the relation “reassignedTask”.
Declaration
public string ReassignedTaskRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “reassignedTask” if it exists, or
SelfRelationLink
Gets the Uri of the link for the relation “self”.
Declaration
public string SelfRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “self” if it exists, or
StampSettingsRelationLink
Gets the Uri of the link for the relation “stampSettings”.
Declaration
public string StampSettingsRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “stampSettings” if it exists, or
Methods
GetDecisionsStampSettingsFromStampSettingsRelation()
Calls the HTTP Get method on the link for the relation “stampSettings”.
Declaration
public DecisionsStampSettings GetDecisionsStampSettingsFromStampSettingsRelation()
Returns
Type | Description |
---|---|
DecisionsStampSettings | The content of the response. |
GetDecisionsStampSettingsFromStampSettingsRelationAsync()
Calls the HTTP Get method on the link for the relation “stampSettings” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DecisionsStampSettings>> GetDecisionsStampSettingsFromStampSettingsRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<DecisionsStampSettings>> | A task which runs the request. |
Remarks
This method follows the link for the relation “stampSettings”.
GetDecisionsStampSettingsFromStampSettingsRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “stampSettings” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<DecisionsStampSettings>> GetDecisionsStampSettingsFromStampSettingsRelationAsync(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<DecisionsStampSettings>> | A task which runs the request. |
Remarks
This method follows the link for the relation “stampSettings”.
GetInstanceHistoryFromHistoryRelation()
Calls the HTTP Get method on the link for the relation “history”.
Declaration
public InstanceHistory GetInstanceHistoryFromHistoryRelation()
Returns
Type | Description |
---|---|
InstanceHistory | The content of the response. |
GetInstanceHistoryFromHistoryRelationAsync()
Calls the HTTP Get method on the link for the relation “history” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<InstanceHistory>> | A task which runs the request. |
Remarks
This method follows the link for the relation “history”.
GetInstanceHistoryFromHistoryRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “history” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<InstanceHistory>> GetInstanceHistoryFromHistoryRelationAsync(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<InstanceHistory>> | A task which runs the request. |
Remarks
This method follows the link for the relation “history”.
GetWorkflowTaskFromMaintenanceSelfRelation()
Calls the HTTP Get method on the link for the relation “maintenanceSelf”.
Declaration
public WorkflowTask GetWorkflowTaskFromMaintenanceSelfRelation()
Returns
Type | Description |
---|---|
WorkflowTask | The content of the response. |
GetWorkflowTaskFromMaintenanceSelfRelationAsync()
Calls the HTTP Get method on the link for the relation “maintenanceSelf” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTask>> GetWorkflowTaskFromMaintenanceSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTask>> | A task which runs the request. |
Remarks
This method follows the link for the relation “maintenanceSelf”.
GetWorkflowTaskFromMaintenanceSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “maintenanceSelf” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTask>> GetWorkflowTaskFromMaintenanceSelfRelationAsync(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<WorkflowTask>> | A task which runs the request. |
Remarks
This method follows the link for the relation “maintenanceSelf”.
GetWorkflowTaskFromSelfRelation()
Calls the HTTP Get method on the link for the relation “self”.
Declaration
public WorkflowTask GetWorkflowTaskFromSelfRelation()
Returns
Type | Description |
---|---|
WorkflowTask | The content of the response. |
GetWorkflowTaskFromSelfRelationAsync()
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTask>> GetWorkflowTaskFromSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTask>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
GetWorkflowTaskFromSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<WorkflowTask>> GetWorkflowTaskFromSelfRelationAsync(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<WorkflowTask>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
PostToReassignedTaskRelationForString(ReassignmentData)
Calls the HTTP Post method on the link for the relation “reassignedTask”.
Declaration
public string PostToReassignedTaskRelationForString(ReassignmentData dataToSend)
Parameters
Type | Name | Description |
---|---|---|
ReassignmentData | dataToSend | The data to send. This data is written into the request body. |
Returns
Type | Description |
---|---|
System.String | The content of the response. |
PostToReassignedTaskRelationForStringAsync(ReassignmentData)
Calls the HTTP Post method on the link for the relation “reassignedTask” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToReassignedTaskRelationForStringAsync(ReassignmentData dataToSend)
Parameters
Type | Name | Description |
---|---|---|
ReassignmentData | 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 “reassignedTask”.
PostToReassignedTaskRelationForStringAsync(System.Threading.CancellationToken, ReassignmentData)
Calls the HTTP Post method on the link for the relation “reassignedTask” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<string>> PostToReassignedTaskRelationForStringAsync(System.Threading.CancellationToken cancellationToken, ReassignmentData dataToSend)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The cancellation token to cancel the request. |
ReassignmentData | 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 “reassignedTask”.
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 |
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.