Class WaitConditionOptions

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Options for wait conditions.

public class WaitConditionOptions : ICloneable

Inheritance

object

WaitConditionOptions

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WaitConditionOptions()

Initializes a new instance of the WaitConditionOptions class.

public WaitConditionOptions()

WaitConditionOptions(Func<bool>, TimeSpan?, string?, CancellationToken?)

Initializes a new instance of the WaitConditionOptions class.

public WaitConditionOptions(Func<bool> conditionCheck, TimeSpan? timeout = null, string? timeoutSummary = null, CancellationToken? cancellationToken = null)

Parameters

conditionCheck Func<bool>

See ConditionCheck.

timeout TimeSpan?

See Timeout.

timeoutSummary string

See TimeoutSummary.

cancellationToken CancellationToken?

See CancellationToken.

Properties

CancellationToken

Gets or sets the cancellation token for the timer. If unset, this defaults to CancellationToken.

public CancellationToken? CancellationToken { get; set; }

Property Value

CancellationToken?

ConditionCheck

Gets or sets the condition function.

public Func<bool> ConditionCheck { get; set; }

Property Value

Func<bool>

Remarks

This function is invoked on each iteration of the event loop. Therefore, it should be fast and side-effect free.

Timeout

Gets or sets an optional timeout.

public TimeSpan? Timeout { get; set; }

Property Value

TimeSpan?

TimeoutSummary

Gets or sets a simple string identifying the timer (created if Timeout is present) that may be visible in UI/CLI. While it can be normal text, it is best to treat as a timer ID.

public string? TimeoutSummary { get; set; }

Property Value

string

Remarks

WARNING: This setting is experimental.

Methods

Clone()

Create a shallow copy of these options.

public virtual object Clone()

Returns

object

A shallow copy of these options.