Workflow Engine .NET

Assembly: OptimaJet.Workflow.FormsPlugin

Class FormsRuntimeApi

OptimaJet.Workflow.Plugins.FormsPlugin.FormsRuntimeApi

Contains a set of methods that can be used to manipulate forms bound to processes.

Namespace: OptimaJet.Workflow.Plugins.FormsPlugin

public sealed class FormsRuntimeApi

Inheritance

  • System.Object

Methods

public Task<GetFormResult> GetFormAsync(GetFormParameters parameters) #
Returns the form as a standalone form, not bound to any process. When GetFormParameters.TenantId is set, the lookup prefers tenant-scoped forms and falls back to shared forms according to the persistence provider rules.

Parameters

Name
Type
Description
parameters
GetFormParameters
The get form parameters.

Returns

Type
Description
Task<GetFormResult>
The result of the get form operation.
public Task<GetProcessFormResult> GetProcessFormAsync(GetProcessFormParameters parameters) #
Returns the form bound to a process.

Parameters

Name
Type
Description
parameters
GetProcessFormParameters
The get form parameters.

Returns

Type
Description
Task<GetProcessFormResult>
The result of the get form operation.
public Task<GetExecutableFormsResult> GetExecutableFormsAsync(GetExecutableFormsParameters parameters, CancellationToken token = default) #
Returns the form bound to a process and the process commands that the user has access to.

Parameters

Name
Type
Description
parameters
GetExecutableFormsParameters
The get form parameters.
token
CancellationToken
The cancellation token.

Returns

Type
Description
Task<GetExecutableFormsResult>
The result of the get form operation.
public Task<SaveFormResult> SaveFormAsync(SaveFormParameters parameters, CancellationToken token = default) #
Saves form data to process parameters.

Parameters

Name
Type
Description
parameters
SaveFormParameters
The form save parameters.
token
CancellationToken
The cancellation token.

Returns

Type
Description
Task<SaveFormResult>
The result of the form save operation.
public Task<ExecuteFormResult> ExecuteFormAsync(ExecuteFormParameters parameters, CancellationToken token = default) #
Executes a form. Form execution means saving the form and executing a command bound to the form.

Parameters

Name
Type
Description
parameters
ExecuteFormParameters
The form execution parameters.
token
CancellationToken
The cancellation token.

Returns

Type
Description
Task<ExecuteFormResult>
The result of the form execution.