Documentation

TemporalFailure extends TemporalException
in package
implements Stringable

Represents failures that can cross workflow and activity boundaries.

Only exceptions that extend this class will be propagated to the caller.

Never extend this class or any of its derivatives. They are to be used by the SDK code only. Throw an instance [](ApplicationFailure) to pass application specific errors between workflows and activities.

Any unhandled exception thrown by an activity or workflow will be converted to an instance of [](ApplicationFailure).

Table of Contents

Interfaces

Stringable

Properties

$failure  : Failure|null
$originalMessage  : string
$originalStackTrace  : string|null

Methods

__construct()  : mixed
__toString()  : string
getFailure()  : Failure|null
getOriginalMessage()  : string
getOriginalStackTrace()  : string|null
hasOriginalStackTrace()  : bool
setDataConverter()  : void
setFailure()  : void
setOriginalStackTrace()  : void
buildMessage()  : string
Explain known types of key=>value pairs.

Properties

Methods

__construct()

public __construct(string $message[, string|null $originalMessage = null ][, Throwable|null $previous = null ]) : mixed
Parameters
$message : string
$originalMessage : string|null = null
$previous : Throwable|null = null

getFailure()

public getFailure() : Failure|null
Return values
Failure|null

getOriginalMessage()

public getOriginalMessage() : string
Return values
string

getOriginalStackTrace()

public getOriginalStackTrace() : string|null
Return values
string|null

hasOriginalStackTrace()

public hasOriginalStackTrace() : bool
Tags
psalm-assert-if-true

non-empty-string $this->originalStackTrace

psalm-assert-if-false

null $this->originalStackTrace

Return values
bool

setFailure()

public setFailure(Failure|null $failure) : void
Parameters
$failure : Failure|null

setOriginalStackTrace()

public setOriginalStackTrace(string $stackTrace) : void
Parameters
$stackTrace : string

buildMessage()

Explain known types of key=>value pairs.

protected static buildMessage(array<string|int, mixed> $values) : string
Parameters
$values : array<string|int, mixed>
Return values
string

        
On this page

Search results