FilterActivity interface

Filter and return results from input array based on the conditions.

Extends

Properties

condition

Condition to be used for filtering the input.

items

Input array on which filter should be applied.

type

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

Inherited Properties

dependsOn

Activity depends on condition.

description

Activity description.

name

Activity name.

onInactiveMarkAs

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.

state

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

userProperties

Activity user properties.

Property Details

condition

Condition to be used for filtering the input.

condition: Expression

Property Value

items

Input array on which filter should be applied.

items: Expression

Property Value

type

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

type: "Filter"

Property Value

"Filter"

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

Inherited From ControlActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ControlActivity.description

name

Activity name.

name: string

Property Value

string

Inherited From ControlActivity.name

onInactiveMarkAs

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.

onInactiveMarkAs?: string

Property Value

string

Inherited From ControlActivity.onInactiveMarkAs

state

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

state?: string

Property Value

string

Inherited From ControlActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

Inherited From ControlActivity.userProperties