Package version:

Interface SwitchActivity

This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property.

interface SwitchActivity {
    cases?: SwitchCase[];
    defaultActivities?: ActivityUnion[];
    dependsOn?: ActivityDependency[];
    description?: string;
    name: string;
    on: Expression;
    onInactiveMarkAs?: string;
    state?: string;
    type: "Switch";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

cases? defaultActivities? dependsOn? description? name on onInactiveMarkAs? state? type userProperties?

Properties

Optionalcases

cases?: SwitchCase[]

List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities.

OptionaldefaultActivities

defaultActivities?: ActivityUnion[]

List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action.

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

name

name: string

Activity name.

on

on: Expression

An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Optionalstate

state?: string

Activity state. This is an optional property and if not provided, the state will be Active by default.

type

type

Polymorphic discriminator, which specifies the different types this object can be

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility