Class ChildWorkflowHandle

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Handle representing a started child workflow.

public abstract class ChildWorkflowHandle

Inheritance

object

ChildWorkflowHandle

Derived

ChildWorkflowHandle<TWorkflow>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FirstExecutionRunId

Gets the initial run ID of the child workflow.

public abstract string FirstExecutionRunId { get; }

Property Value

string

Id

Gets the ID of the child workflow.

public abstract string Id { get; }

Property Value

string

Methods

GetResultAsync()

Wait for result of the child workflow, ignoring the return value.

public Task GetResultAsync()

Returns

Task

Task representing completion.

Exceptions

ChildWorkflowFailureException

Any child workflow failure.

GetResultAsync<TResult>()

Wait for the result of the child workflow.

public abstract Task<TResult> GetResultAsync<TResult>()

Returns

Task<TResult>

Task with result.

Type Parameters

TResult

Result type to convert to.

Exceptions

ChildWorkflowFailureException

Any child workflow failure.

Exception

Failure converting to result type.

SignalAsync(string, IReadOnlyCollection<object?>, ChildWorkflowSignalOptions?)

Signal a child workflow.

public abstract Task SignalAsync(string signal, IReadOnlyCollection<object?> args, ChildWorkflowSignalOptions? options = null)

Parameters

signal string

Signal to send.

args IReadOnlyCollection<object>

Signal arguments.

options ChildWorkflowSignalOptions

Options for the signal.

Returns

Task

Task for completion of the signal send.

SignalAsync<TWorkflow>(Expression<Func<TWorkflow, Task>>, ChildWorkflowSignalOptions?)

Signal a child workflow via a lambda call to a WorkflowSignal attributed method.

public Task SignalAsync<TWorkflow>(Expression<Func<TWorkflow, Task>> signalCall, ChildWorkflowSignalOptions? options = null)

Parameters

signalCall Expression<Func<TWorkflow, Task>>

Invocation of a workflow signal method.

options ChildWorkflowSignalOptions

Options for the signal.

Returns

Task

Task for completion of the signal send.

Type Parameters

TWorkflow

Workflow class type.