Documentation

ActivityCompletionClientInterface

Used to complete asynchronously activities that called {@link ActivityContext->doNotCompleteOnReturn()}.

Use [](WorkflowClient->newActivityCompletionClient()) to create an instance.

Table of Contents

Methods

complete()  : void
completeByToken()  : void
completeExceptionally()  : void
completeExceptionallyByToken()  : void
recordHeartbeat()  : mixed
recordHeartbeatByToken()  : mixed
reportCancellation()  : void
reportCancellationByToken()  : void

Methods

complete()

public complete(string $workflowId, string|null $runId, string $activityId[, mixed $result = null ]) : void
Parameters
$workflowId : string
$runId : string|null
$activityId : string
$result : mixed = null

completeByToken()

public completeByToken(string $taskToken[, mixed $result = null ]) : void
Parameters
$taskToken : string
$result : mixed = null

completeExceptionally()

public completeExceptionally(string $workflowId, string|null $runId, string $activityId, Throwable $error) : void
Parameters
$workflowId : string
$runId : string|null
$activityId : string
$error : Throwable

completeExceptionallyByToken()

public completeExceptionallyByToken(string $taskToken, Throwable $error) : void
Parameters
$taskToken : string
$error : Throwable

recordHeartbeat()

public recordHeartbeat(string $workflowId, string|null $runId, string $activityId[, mixed $details = null ]) : mixed
Parameters
$workflowId : string
$runId : string|null
$activityId : string
$details : mixed = null
Tags
throws
ActivityCanceledException

recordHeartbeatByToken()

public recordHeartbeatByToken(string $taskToken[, mixed $details = null ]) : mixed
Parameters
$taskToken : string
$details : mixed = null
Tags
throws
ActivityCanceledException

reportCancellation()

public reportCancellation(string $workflowId, string|null $runId, string $activityId[, mixed $details = null ]) : void
Parameters
$workflowId : string
$runId : string|null
$activityId : string
$details : mixed = null

reportCancellationByToken()

public reportCancellationByToken(string $taskToken[, mixed $details = null ]) : void
Parameters
$taskToken : string
$details : mixed = null

        
On this page

Search results