Remove From Collection

Removes the first matching item, or the item at an index, from a list.

Behaviour

Risk: Low · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

Package System activities VeloPhex.System.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.system.removeFromCollection

Properties#

Input#

Collection#

Collection · IList · Required · Default: Not specified in package metadata

The list to remove from.

Item#

Item · Object · Optional · Default: Not specified in package metadata

The item to remove (its first occurrence).

Index#

Index · Int32? · Optional · Default: Not specified in package metadata

The zero-based position to remove, in place of Item.

Output#

Removed#

Removed · Boolean · Output

Whether an item was removed.

Rules#

• Set only one of: Item, Index.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Add To Collection
• Clear Collection
• Exists In Collection
• Read List Item
• Update List Item

Generated from VeloPhex.System.Activities 0.7.1-rc.12. Category: Collection. Keywords: collection, list, remove, delete, item, array.

Properties

Input

Output

Rules

Retry and risk

Related activities