Class: AsyncCompletionClient
client.AsyncCompletionClient
A client for asynchronous completion and heartbeating of Activities.
Constructors
constructor
• new AsyncCompletionClient(service?, options?)
Parameters
| Name | Type |
|---|---|
service? | WorkflowService |
options? | AsyncCompletionClientOptions |
Properties
options
• Readonly options: Required<AsyncCompletionClientOptions>
service
• Readonly service: WorkflowService
Methods
complete
▸ complete(taskToken, result): Promise<void>
Complete an Activity by task token
Parameters
| Name | Type |
|---|---|
taskToken | Uint8Array |
result | unknown |
Returns
Promise<void>
▸ complete(fullActivityId, result): Promise<void>
Complete an Activity by full ID
Parameters
| Name | Type |
|---|---|
fullActivityId | FullActivityId |
result | unknown |
Returns
Promise<void>
fail
▸ fail(taskToken, err): Promise<void>
Fail an Activity by task token
Parameters
| Name | Type |
|---|---|
taskToken | Uint8Array |
err | unknown |
Returns
Promise<void>
▸ fail(fullActivityId, err): Promise<void>
Fail an Activity by full ID
Parameters
| Name | Type |
|---|---|
fullActivityId | FullActivityId |
err | unknown |
Returns
Promise<void>
heartbeat
▸ heartbeat(taskToken, details?): Promise<void>
Send Activity heartbeat by task token
Parameters
| Name | Type |
|---|---|
taskToken | Uint8Array |
details? | unknown |
Returns
Promise<void>
▸ heartbeat(fullActivityId, details?): Promise<void>
Send Activity heartbeat by full ID
Parameters
| Name | Type |
|---|---|
fullActivityId | FullActivityId |
details? | unknown |
Returns
Promise<void>
reportCancellation
▸ reportCancellation(taskToken, details?): Promise<void>
Report Activity cancellation by task token
Parameters
| Name | Type |
|---|---|
taskToken | Uint8Array |
details? | unknown |
Returns
Promise<void>
▸ reportCancellation(fullActivityId, details?): Promise<void>
Report Activity cancellation by full ID
Parameters
| Name | Type |
|---|---|
fullActivityId | FullActivityId |
details? | unknown |
Returns
Promise<void>