Interface IWorkflowClient

Hierarchy

IWorkflowClient

Index

Methods

Methods

cancelWorkflowInstance

cancelWorkflowInstance(instance: string | number): Promise<void>

- Defined in src/core/camunda/workflowClient.ts:25
Parameters
- instance: string | number
Returns Promise<void>

createWorkflowInstance

createWorkflowInstance<T>(payload: ICreateWorkflowInstance<T>): Promise<ICreateWorkflowInstanceResponse>

- Defined in src/core/camunda/workflowClient.ts:26
Type parameters
- T = unknown
Parameters
- payload: ICreateWorkflowInstance<T>
Returns Promise<ICreateWorkflowInstanceResponse>

deployWorkflow

deployWorkflow(absPath: string): Promise<Readonly<IDeployWorkflowResponse>>

- Defined in src/core/camunda/workflowClient.ts:20
Parameters
- absPath: string
Returns Promise<Readonly<IDeployWorkflowResponse>>

getWorkflow

getWorkflow(payload: IWorkflowDefinitionRequest): Promise<IWorkflowDefinition>

- Defined in src/core/camunda/workflowClient.ts:28
Parameters
- payload: IWorkflowDefinitionRequest
Returns Promise<IWorkflowDefinition>

getWorkflows

getWorkflows(options?: Partial<IWorkflowOptions & IPaginationOptions>): Promise<IPagination<IWorkflow>>

- Defined in src/core/camunda/workflowClient.ts:21
Parameters
- Optional options: Partial<IWorkflowOptions & IPaginationOptions>
Returns Promise<IPagination<IWorkflow>>

publishMessage

publishMessage<T>(payload: IPublishMessage<T, unknown>): Promise<void>

- Defined in src/core/camunda/workflowClient.ts:24
Type parameters
- T = unknown
Parameters
- payload: IPublishMessage<T, unknown>
Returns Promise<void>

resolveIncident

resolveIncident(incidentKey: string): Promise<void>

- Defined in src/core/camunda/workflowClient.ts:27
Parameters
- incidentKey: string
Returns Promise<void>

updateJobRetries

updateJobRetries(payload: IUpdateWorkflowRetry): Promise<void>

- Defined in src/core/camunda/workflowClient.ts:23
Parameters
- payload: IUpdateWorkflowRetry
Returns Promise<void>

updateVariables

updateVariables(payload: IUpdateWorkflowVariables<unknown>): Promise<void>

- Defined in src/core/camunda/workflowClient.ts:22
Parameters
- payload: IUpdateWorkflowVariables<unknown>
Returns Promise<void>

Generated using TypeDoc