Class WorkflowSignalDefinition

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Definition of a workflow signal.

public class WorkflowSignalDefinition

Inheritance

object

WorkflowSignalDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description

Gets the optional signal description.

public string? Description { get; }

Property Value

string

Remarks

WARNING: This setting is experimental.

Dynamic

Gets a value indicating whether the signal is dynamic.

public bool Dynamic { get; }

Property Value

bool

Name

Gets the signal name. This is null if the signal is dynamic.

public string? Name { get; }

Property Value

string

Methods

CreateWithoutAttribute(string?, Delegate, HandlerUnfinishedPolicy, string?)

Creates a signal definition from an explicit name and method. Most users should use FromMethod(MethodInfo) with attributes instead.

public static WorkflowSignalDefinition CreateWithoutAttribute(string? name, Delegate del, HandlerUnfinishedPolicy unfinishedPolicy = HandlerUnfinishedPolicy.WarnAndAbandon, string? description = null)

Parameters

name string

Signal name. Null for dynamic signal.

del Delegate

Signal delegate.

unfinishedPolicy HandlerUnfinishedPolicy

Actions taken if a workflow exits with a running instance of this handler.

description string

Optional description. WARNING: This setting is experimental.

Returns

WorkflowSignalDefinition

Signal definition.

FromMethod(MethodInfo)

Get a signal definition from a method or fail. The result is cached.

public static WorkflowSignalDefinition FromMethod(MethodInfo method)

Parameters

method MethodInfo

Signal method.

Returns

WorkflowSignalDefinition

Signal definition.