Previous Docs Version

The documentation you are viewing is for a previous version of the Vendr product. Click here to jump to the current stable version.

PipelineTaskBase<T,TResult>

API reference for PipelineTaskBase<T,TResult> in Vendr, the eCommerce solution for Umbraco v8+

PipelineTaskBase<T,TResult>

public abstract class PipelineTaskBase<T, TResult> : PipelineTaskBase, IPipelineAction<T>, 
    IPipelineTask<T, TResult>

Inheritance

Namespace

Methods

Execute

Executes the pipeline task.

public override PipelineResult Execute(PipelineArgs input)

Parameters

Parameter Description
input
The pipeline args.

Returns

A pipeline result.


Execute

Executes the pipeline task.

public abstract PipelineResult<TResult> Execute(PipelineArgs<T> args)

Parameters

Parameter Description
input
The pipeline args.

Returns

A pipeline result.


Fail

Creates a fail pipeline result.

public virtual PipelineResult<TResult> Fail()

Returns

A fail pipeline result.


Fail (1 of 2)

Creates a fail pipeline result.

public override PipelineResult Fail(object result)

Parameters

Parameter Description
result
The result data.

Returns

A fail pipeline result.


Fail (2 of 2)

Creates a fail pipeline result.

public override PipelineResult Fail(object result, Exception exception)

Parameters

Parameter Description
result
The result data.
exception
An exception message.

Returns

A fail pipeline result.


Fail (1 of 3)

Creates a fail pipeline result.

public virtual PipelineResult<TResult> Fail(TResult result)

Parameters

Parameter Description
result
The result data.

Returns

A fail pipeline result.


Fail (2 of 3)

Creates a fail pipeline result.

public virtual PipelineResult<TResult> Fail(Exception exception)

Parameters

Parameter Description
exception
An exception message.

Returns

A fail pipeline result.


Fail (3 of 3)

Creates a fail pipeline result.

public virtual PipelineResult<TResult> Fail(TResult result, Exception exception)

Parameters

Parameter Description
result
The result data.
exception
An exception message.

Returns

A fail pipeline result.


Ok

Creates a success pipeline result.

public virtual PipelineResult<TResult> Ok()

Returns

A success pipeline result.


Ok

Creates a success pipeline result.

public override PipelineResult Ok(object result)

Parameters

Parameter Description
result
The result data.

Returns

A success pipeline result.


Ok

Creates a success pipeline result.

public virtual PipelineResult<TResult> Ok(TResult result)

Parameters

Parameter Description
result
The result data.

Returns

A success pipeline result.

Edit this page on GitHub

Site + logo design © 2024 Outfield Digital Ltd. Content contributions licensed under MIT.
Vendr® is a Registered Trademark of Outfield Digital Ltd.