Class TemporalException

Namespace

Temporalio.Exceptions

Assembly

Temporalio.dll

Base exception for all custom exceptions thrown by the Temporal library.

public abstract class TemporalException : Exception, ISerializable

Inheritance

object

Exception

TemporalException

Implements

ISerializable

Derived

CompleteAsyncException

AsyncActivityCanceledException

FailureException

InvalidWorkflowOperationException

RpcException

RpcTimeoutOrCanceledException

WorkflowContinuedAsNewException

WorkflowFailedException

WorkflowQueryFailedException

WorkflowQueryRejectedException

WorkflowUpdateFailedException

ContinueAsNewException

Inherited Members

Exception.GetBaseException()

Exception.GetObjectData(SerializationInfo, StreamingContext)

Exception.GetType()

Exception.ToString()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

TemporalException()

Initializes a new instance of the TemporalException class.

protected TemporalException()

TemporalException(string)

Initializes a new instance of the TemporalException class.

protected TemporalException(string message)

Parameters

message string

Message for the exception.

TemporalException(string, Exception?)

Initializes a new instance of the TemporalException class.

protected TemporalException(string message, Exception? inner)

Parameters

message string

Message for the exception.

inner Exception

Cause of the exception.

Methods

IsCanceledException(Exception)

Whether the given exception is a .NET cancellation or a Temporal cancellation (including a cancellation inside an activity or child exception).

public static bool IsCanceledException(Exception e)

Parameters

e Exception

Exception to check.

Returns

bool

True if the exception is due to a cancellation.

Remarks

This is useful to determine whether a client/in-workflow caught exception is due to cancellation. Temporal wraps exceptions or reuses .NET cancellation exceptions, so a simple type check is not enough to be sure.