Class Designer

Extension which provides API for HTML5 Workflow Designer

Inheritance

↳ object

    ↳ Designer

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public static class Designer

Properties

ProcessHistoryPageSize

Declaration

public static int ProcessHistoryPageSize { get; }

Property value

Type	Description
int

Methods

DesignerAPI(WorkflowRuntime, NameValueCollection, Stream, bool)

Declaration

[Obsolete("Use DesignerApi method with out hasError parameter")]
public static string DesignerAPI(this WorkflowRuntime runtime, NameValueCollection form, Stream filestream = null, bool setIsObsoleForOperationSave = true)

Parameters

Type	Name	Description
WorkflowRuntime	runtime
NameValueCollection	form
Stream	filestream
bool	setIsObsoleForOperationSave

Returns

Type	Description
string

DesignerAPI(WorkflowRuntime, NameValueCollection, out bool, Stream, bool)

API for HTML5 Workflow Designer. Contains following operations:

• bool exists(schemecode, schemeid, processid) Checks existence of the scheme of the process with specific code, id or id of the process
• JSON load(schemecode, schemeid, processid) Returns the scheme of the process in JSON format by specific code, id or id of the process
• JSON save(schemecode, data) Saves the scheme with specified code. Ruturns updated scheme.
• JSON uploadscheme(filestream) Converts scheme uploaded as XML file to JSON.
• XML downloadscheme(data) Converts scheme from JSON object to XML.
• object compile(data) Method for test compile of code actions
• JSON getemptytype(typename) returns serialized empty type
• array getautocompletesuggestions (category, value) returns a list of autocomplete suggestions
• JSON uploadschemebpmn(filestream) Converts BPMN scheme uploaded as XML file to JSON.
• XML downloadschemebpmn(data) Converts BPMN scheme from JSON object to XML. Type of the operation determined by "operation" parameter from request parameters

Declaration

public static string DesignerAPI(this WorkflowRuntime runtime, NameValueCollection form, out bool hasError, Stream fileStream = null, bool setIsObsoleteForOperationSave = true)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
NameValueCollection	form	Parameters from request. Allowed parameters is: "operation", "schemecode", "schemeid", "processid", "data"
bool	hasError	If true the result contains info about an exception
Stream	fileStream	Stream which represent uploaded file
bool	setIsObsoleteForOperationSave	If true and operation is "save" IsObsolete property will be set to all shemes of processes with specified code

Returns

Type	Description
string	Operation execution result

DesignerAPIAsync(WorkflowRuntime, NameValueCollection, Stream, bool)

API for HTML5 Workflow Designer. Contains following operations:

• bool exists(schemecode, schemeid, processid) Checks existence of the scheme of the process with specific code, id or id of the process
• JSON load(schemecode, schemeid, processid) Returns the scheme of the process in JSON format by specific code, id or id of the process
• JSON save(schemecode, data) Saves the scheme with specified code. Ruturns updated scheme.
• JSON uploadscheme(filestream) Converts scheme uploaded as XML file to JSON.
• XML downloadscheme(data) Converts scheme from JSON object to XML.
• object compile(data) Method for test compile of code actions
• JSON getemptytype(typename) returns serialized empty type
• array getautocompletesuggestions (category, value) returns a list of autocomplete suggestions
• JSON uploadschemebpmn(filestream) Converts BPMN scheme uploaded as XML file to JSON.
• XML downloadschemebpmn(data) Converts BPMN scheme from JSON object to XML. Type of the operation determined by "operation" parameter from request parameters

Declaration

public static Task<(string result, bool hasError)> DesignerAPIAsync(this WorkflowRuntime runtime, NameValueCollection form, Stream fileStream = null, bool setIsObsoleteForOperationSave = true)

Parameters

Type	Name	Description
WorkflowRuntime	runtime	The instance of the runtime
NameValueCollection	form	Parameters from request. Allowed parameters is: "operation", "schemecode", "schemeid", "processid", "data". Look at <xref href="OptimaJet.Workflow.Core.Designer.RequestElements" data-throw-if-not-resolved="false"></xref>
Stream	fileStream	Stream which represent uploaded file
bool	setIsObsoleteForOperationSave	If true and operation is "save" IsObsolete property will be set to all shemes of processes with specified code

Returns

Type	Description
Task<(string result, bool hasError)>	Operation execution result

RegisterTypesFromAssembly(Assembly, Func<Type, bool>)

Declaration

public static void RegisterTypesFromAssembly(Assembly assembly, Func<Type, bool> filter = null)

Parameters

Type	Name	Description
Assembly	assembly
Func<Type, bool>	filter