Class ExternalWorkflowHandle

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Handle representing an external workflow.

public abstract class ExternalWorkflowHandle

Inheritance

object

ExternalWorkflowHandle

Derived

ExternalWorkflowHandle<TWorkflow>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Id

Gets the ID of the external workflow.

public abstract string Id { get; }

Property Value

string

RunId

Gets the initial run ID of the child workflow.

public abstract string? RunId { get; }

Property Value

string

Methods

CancelAsync()

Cancel an external workflow.

public abstract Task CancelAsync()

Returns

Task

Task for completion of the cancellation request.

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

Signal an external workflow.

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

Parameters

signal string

Signal to send.

args IReadOnlyCollection<object>

Signal arguments.

options ExternalWorkflowSignalOptions

Options for the signal.

Returns

Task

Task for completion of the signal send.

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

Signal an external workflow via a lambda call to a WorkflowSignal attributed method.

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

Parameters

signalCall Expression<Func<TWorkflow, Task>>

Invocation of a workflow signal method.

options ExternalWorkflowSignalOptions

Options for the signal.

Returns

Task

Task for completion of the signal send.

Type Parameters

TWorkflow

Workflow class type.