Interface: EnrichedActivatedJob
Defined in: runtime/jobActions.ts:10
Enriched job type with convenience methods.
Extends
ActivatedJobResult
Properties
acknowledged?
optional acknowledged: boolean;
Defined in: runtime/jobActions.ts:23
Set true once any acknowledgement method is invoked.
customHeaders
customHeaders: object;
Defined in: gen/types.gen.ts:11720
A set of custom headers defined during modelling; returned as a serialized JSON document.
Index Signature
[key: string]: unknown
Inherited from
ActivatedJobResult.customHeaders;
deadline
deadline: number;
Defined in: gen/types.gen.ts:11734
When the job can be activated again, sent as a UNIX epoch timestamp.
Inherited from
ActivatedJobResult.deadline;
elementId
elementId: ElementId;
Defined in: gen/types.gen.ts:11716
The associated task element ID.
Inherited from
ActivatedJobResult.elementId;
elementInstanceKey
elementInstanceKey: ElementInstanceKey;
Defined in: gen/types.gen.ts:11757
Inherited from
ActivatedJobResult.elementInstanceKey;
jobKey
jobKey: JobKey;
Defined in: gen/types.gen.ts:11748
The key, a unique identifier for the job.
Inherited from
ActivatedJobResult.jobKey;
kind
kind: JobKindEnum;
Defined in: gen/types.gen.ts:11758
Inherited from
ActivatedJobResult.kind;
listenerEventType
listenerEventType: JobListenerEventTypeEnum;
Defined in: gen/types.gen.ts:11759
Inherited from
ActivatedJobResult.listenerEventType;
log
log: Logger;
Defined in: runtime/jobActions.ts:21
modifyJobTimeout()
modifyJobTimeout: (__namedParameters) => Promise<void>;
Defined in: runtime/jobActions.ts:19
Extend the timeout for the job by setting a new timeout
Parameters
__namedParameters
newTimeoutMs
number
Returns
Promise<void>
modifyRetries()
modifyRetries: (__namedParameters) => Promise<void>;
Defined in: runtime/jobActions.ts:20
Parameters
__namedParameters
retries
number
Returns
Promise<void>
processDefinitionId
processDefinitionId: ProcessDefinitionId;
Defined in: gen/types.gen.ts:11708
The bpmn process ID of the job's process definition.
Inherited from
ActivatedJobResult.processDefinitionId;
processDefinitionKey
processDefinitionKey: ProcessDefinitionKey;
Defined in: gen/types.gen.ts:11756
The key of the job's process definition.
Inherited from
ActivatedJobResult.processDefinitionKey;
processDefinitionVersion
processDefinitionVersion: number;
Defined in: gen/types.gen.ts:11712
The version of the job's process definition.
Inherited from
ActivatedJobResult.processDefinitionVersion;
processInstanceKey
processInstanceKey: ProcessInstanceKey;
Defined in: gen/types.gen.ts:11752
The job's process instance key.
Inherited from
ActivatedJobResult.processInstanceKey;
retries
retries: number;
Defined in: gen/types.gen.ts:11730
The amount of retries left to this job (should always be positive).
Inherited from
ActivatedJobResult.retries;
tags?
optional tags: TagSet;
Defined in: gen/types.gen.ts:11805
Inherited from
ActivatedJobResult.tags;
tenantId
tenantId: TenantId;
Defined in: gen/types.gen.ts:11744
The ID of the tenant that owns the job.
Inherited from
ActivatedJobResult.tenantId;
type
type: string;
Defined in: gen/types.gen.ts:11704
The type of the job (should match what was requested).
Inherited from
ActivatedJobResult.type;
userTask?
optional userTask: object;
Defined in: gen/types.gen.ts:11763
Contains properties of a user task.
action?
optional action: string;
The action performed on the user task.
assignee?
optional assignee: string | null;
The user assigned to the task.
candidateGroups?
optional candidateGroups: string[];
The groups eligible to claim the task.
candidateUsers?
optional candidateUsers: string[];
The users eligible to claim the task.
changedAttributes?
optional changedAttributes: string[];
The attributes that were changed in the task.
dueDate?
optional dueDate: string | null;
The due date of the user task in ISO 8601 format.
followUpDate?
optional followUpDate: string | null;
The follow-up date of the user task in ISO 8601 format.
formKey?
optional formKey: FormKey;
The key of the form associated with the user task.
priority?
optional priority: number | null;
The priority of the user task.
userTaskKey?
optional userTaskKey: UserTaskKey | null;
The unique key identifying the user task.
Inherited from
ActivatedJobResult.userTask;
variables
variables: object;
Defined in: gen/types.gen.ts:11738
All variables visible to the task scope, computed at activation time.
Index Signature
[key: string]: unknown
Inherited from
ActivatedJobResult.variables;
worker
worker: string;
Defined in: gen/types.gen.ts:11726
The name of the worker which activated this job.
Inherited from
ActivatedJobResult.worker;
Methods
cancelWorkflow()
cancelWorkflow(): Promise<"JOB_ACTION_RECEIPT">;
Defined in: runtime/jobActions.ts:14
Returns
Promise<"JOB_ACTION_RECEIPT">
complete()
complete(variables?): Promise<"JOB_ACTION_RECEIPT">;
Defined in: runtime/jobActions.ts:11
Parameters
variables?
Returns
Promise<"JOB_ACTION_RECEIPT">
error()
error(error): Promise<"JOB_ACTION_RECEIPT">;
Defined in: runtime/jobActions.ts:13
Parameters
error
Returns
Promise<"JOB_ACTION_RECEIPT">
fail()
fail(body): Promise<"JOB_ACTION_RECEIPT">;
Defined in: runtime/jobActions.ts:12
Parameters
body
any
Returns
Promise<"JOB_ACTION_RECEIPT">
ignore()
ignore(): Promise<"JOB_ACTION_RECEIPT">;
Defined in: runtime/jobActions.ts:15
Returns
Promise<"JOB_ACTION_RECEIPT">