Type Alias ElementInstanceWaitStateResult

An element instance waiting state.

type ElementInstanceWaitStateResult = {
    elementId: ElementId;
    elementInstanceKey: ElementInstanceKey;
    elementType: WaitStateElementTypeEnum;
    jobDetails: JobWaitStateDetails | null;
    messageDetails: MessageWaitStateDetails | null;
    processInstanceKey: ProcessInstanceKey;
    rootProcessInstanceKey: ProcessInstanceKey | null;
    tenantId: TenantId;
    waitStateType: WaitStateTypeEnum;
}

Index

Properties

elementId elementInstanceKey elementType jobDetails messageDetails processInstanceKey rootProcessInstanceKey tenantId waitStateType

Properties

elementId

elementId: ElementId

The element ID for this element instance.

elementInstanceKey

elementInstanceKey: ElementInstanceKey

The element instance key associated to this element instance.

elementType

elementType: WaitStateElementTypeEnum

The BPMN element type of this element instance.

jobDetails

jobDetails: JobWaitStateDetails | null

Job details, present when waitStateType is JOB.

messageDetails

messageDetails: MessageWaitStateDetails | null

Message details, present when waitStateType is MESSAGE.

processInstanceKey

processInstanceKey: ProcessInstanceKey

The process instance key associated to this element instance.

rootProcessInstanceKey

rootProcessInstanceKey: ProcessInstanceKey | null

Key of the root process instance.

tenantId

tenantId: TenantId

The tenant ID of the element instance.

waitStateType

waitStateType: WaitStateTypeEnum

The type of waiting state an element instance is in.