Class TaskOrchestration<TResult, TInput, TEvent, TStatus>

Namespace

DurableTask.Core

Assembly

DurableTask.Core.dll

Typed base class for Task orchestration with typed events and status

public abstract class TaskOrchestration<TResult, TInput, TEvent, TStatus> : TaskOrchestration

Type Parameters

TResult

Output type of the orchestration

TInput

Input type for the orchestration

TEvent

Input type for RaiseEvent calls

TStatus

Output Type for GetStatus calls

Inheritance

object

TaskOrchestration

TaskOrchestration<TResult, TInput, TEvent, TStatus>

Derived

TaskOrchestration<TResult, TInput>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TaskOrchestration()

Creates a new TaskOrchestration with the default DataConverter

protected TaskOrchestration()

Properties

DataConverter

The DataConverter to use for input and output serialization/deserialization

public DataConverter DataConverter { get; protected set; }

Property Value

DataConverter

Methods

Execute(OrchestrationContext, string)

Method for executing an orchestration based on the context and serialized input

public override Task<string> Execute(OrchestrationContext context, string input)

Parameters

context OrchestrationContext

The orchestration context

input string

The serialized input

Returns

Task<string>

Serialized output from the execution

GetStatus()

Gets the current status of the orchestration

public override string GetStatus()

Returns

string

The string status

OnEvent(OrchestrationContext, string, TEvent)

Virtual method for processing an event with given context, name and typed input

public virtual void OnEvent(OrchestrationContext context, string name, TEvent input)

Parameters

context OrchestrationContext

The orchestration context

name string

Name for this event

input TEvent

Typed input

OnGetStatus()

Method for getting typed status of the orchestration

public virtual TStatus OnGetStatus()

Returns

TStatus

The typed status

RaiseEvent(OrchestrationContext, string, string)

Method for raising an event in the orchestration

public override void RaiseEvent(OrchestrationContext context, string name, string input)

Parameters

context OrchestrationContext

The orchestration context

name string

Name for this event to be passed to the OnEvent handler

input string

The serialized input

RunTask(OrchestrationContext, TInput)

Method for executing the orchestration with context and typed input

public abstract Task<TResult> RunTask(OrchestrationContext context, TInput input)

Parameters

context OrchestrationContext

The orchestration context

input TInput

The typed input

Returns

Task<TResult>

The typed output