Interface Rule

See: relevant section in reference guide

interface Rule {
    $CreationOptions?: RuleCreationOptions;
    $ID: string;
    $Type: "Microflows$Rule";
    applyEntityAccess: boolean;
    documentation: string;
    excluded: boolean;
    exportLevel: ExportLevel;
    flows: Flow[];
    markAsUsed: boolean;
    microflowReturnType: DataType;
    name: string;
    objectCollection: MicroflowObjectCollection;
    parameters: RuleParameter[];
    returnVariableName: string;
    addAnnotationFlow(): Promise<AnnotationFlow>;
    addRuleParameter(
        options: RuleParameterCreationOptions,
    ): Promise<RuleParameter>;
    addSequenceFlow(
        options: SequenceFlowSchemaInitOptions,
    ): Promise<SequenceFlow>;
    getRuleParameter(name: string): undefined | RuleParameter;
}

Hierarchy (View Summary)

ServerSideMicroflowBase
- Rule

Index

Properties

$CreationOptions? $ID $Type applyEntityAccess documentation excluded exportLevel flows markAsUsed microflowReturnType name objectCollection parameters returnVariableName

Methods

addAnnotationFlow addRuleParameter addSequenceFlow getRuleParameter

Properties

`Optional`$CreationOptions

$CreationOptions?: RuleCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "Microflows$Rule"

The type of the element.

applyEntityAccess

applyEntityAccess: boolean

documentation

documentation: string

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

flows

flows: Flow[]

markAsUsed

markAsUsed: boolean

microflowReturnType

microflowReturnType: DataType

name

name: string

objectCollection

objectCollection: MicroflowObjectCollection

parameters

parameters: RuleParameter[]

returnVariableName

returnVariableName: string

Methods

addAnnotationFlow

addAnnotationFlow(): Promise<AnnotationFlow>
Returns Promise<AnnotationFlow>
Inherited from ServerSideMicroflowBase.addAnnotationFlow

addRuleParameter

addRuleParameter(options: RuleParameterCreationOptions): Promise<RuleParameter>
Parameters
- options: RuleParameterCreationOptions
Returns Promise<RuleParameter>

addSequenceFlow

addSequenceFlow(options: SequenceFlowSchemaInitOptions): Promise<SequenceFlow>
Parameters
- options: SequenceFlowSchemaInitOptions
Returns Promise<SequenceFlow>
Inherited from ServerSideMicroflowBase.addSequenceFlow

getRuleParameter

getRuleParameter(name: string): undefined | RuleParameter
Parameters
- name: string
Returns undefined | RuleParameter