WorkflowHandleInterface
in
Workflow interactions shared by live and in-memory handles.
The SDK's handles, WorkflowHandle and TestWorkflowHandle, expose the bound workflow and run as the read-only properties below. The interface does not declare them as methods, so existing application implementations keep loading; PHPStan does not read these tags on an interface.
Table of Contents
Properties
- $selectedRunId : string|null
- $workflowId : string
Methods
- appendMessage() : array<string, mixed>
- query() : mixed
- result() : mixed
- signal() : void
- update() : mixed
Properties
$selectedRunId read-only
public
string|null
$selectedRunId
The run selected when the handle was created, or null to follow the current run.
$workflowId read-only
public
string
$workflowId
The workflow ID the handle is bound to, including an ID the client generated at start.
Methods
appendMessage()
public
appendMessage(string $streamName, string $messageId[, array<int, mixed> $arguments = [] ]) : array<string, mixed>
Parameters
- $streamName : string
- $messageId : string
- $arguments : array<int, mixed> = []
Return values
array<string, mixed>query()
public
query(string $name[, array<int, mixed> $arguments = [] ]) : mixed
Parameters
- $name : string
- $arguments : array<int, mixed> = []
result()
public
result([float $timeoutSeconds = 30.0 ][, float $pollIntervalSeconds = 0.5 ]) : mixed
Parameters
- $timeoutSeconds : float = 30.0
- $pollIntervalSeconds : float = 0.5
signal()
public
signal(string $name[, array<int, mixed> $arguments = [] ]) : void
Parameters
- $name : string
- $arguments : array<int, mixed> = []
update()
public
update(string $name[, array<int, mixed> $arguments = [] ][, string $waitFor = 'completed' ][, int|null $waitTimeoutSeconds = null ][, string|null $requestId = null ]) : mixed
Parameters
- $name : string
- $arguments : array<int, mixed> = []
- $waitFor : string = 'completed'
- $waitTimeoutSeconds : int|null = null
- $requestId : string|null = null