Package version:

Interface ControlActivity

Base class for all control activities like IfCondition, ForEach , Until.

interface ControlActivity {
    dependsOn?: ActivityDependency[];
    description?: string;
    name: string;
    onInactiveMarkAs?: string;
    state?: string;
    type:
        | "Container"
        | "ExecutePipeline"
        | "IfCondition"
        | "Switch"
        | "ForEach"
        | "Wait"
        | "Fail"
        | "Until"
        | "Validation"
        | "Filter"
        | "SetVariable"
        | "AppendVariable"
        | "WebHook";
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

dependsOn? description? name onInactiveMarkAs? state? type userProperties?

Properties

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

name

name: string

Activity name.

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:
    | "Container"
    | "ExecutePipeline"
    | "IfCondition"
    | "Switch"
    | "ForEach"
    | "Wait"
    | "Fail"
    | "Until"
    | "Validation"
    | "Filter"
    | "SetVariable"
    | "AppendVariable"
    | "WebHook"

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

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility