ActivityContextInterface
in
Table of Contents
Methods
- doNotCompleteOnReturn() : void
- Marks the activity as incomplete for asynchronous completion.
- getCancellationDetails() : ActivityCancellationDetails|null
- Cancellation details of the current activity, if any.
- getInfo() : ActivityInfo
- Returns information about current activity execution.
- getInput() : ValuesInterface
- Returns activity execution input arguments.
- getInstance() : object
- Get the currently running activity instance.
- getLastHeartbeatDetails() : mixed
- Returns the payload passed into the last heartbeat.
- hasHeartbeatDetails() : bool
- Check if the heartbeat's first argument has been passed.
- heartbeat() : void
- Use to notify workflow that activity execution is alive.
Methods
doNotCompleteOnReturn()
Marks the activity as incomplete for asynchronous completion.
public
doNotCompleteOnReturn() : void
Tags
getCancellationDetails()
Cancellation details of the current activity, if any.
public
getCancellationDetails() : ActivityCancellationDetails|null
Once set, cancellation details do not change.
Tags
Return values
ActivityCancellationDetails|nullgetInfo()
Returns information about current activity execution.
public
getInfo() : ActivityInfo
Tags
Return values
ActivityInfogetInput()
Returns activity execution input arguments.
public
getInput() : ValuesInterface
Tags
Return values
ValuesInterfacegetInstance()
Get the currently running activity instance.
public
getInstance() : object
Tags
Return values
objectgetLastHeartbeatDetails()
Returns the payload passed into the last heartbeat.
public
getLastHeartbeatDetails([Type|string $type = null ]) : mixed
Parameters
- $type : Type|string = null
Tags
hasHeartbeatDetails()
Check if the heartbeat's first argument has been passed.
public
hasHeartbeatDetails() : bool
Tags
Return values
boolheartbeat()
Use to notify workflow that activity execution is alive.
public
heartbeat(mixed $details) : void
Parameters
- $details : mixed