Interface IWorkflowSignal

Сигнал в Workflow API. Обеспечивает взаимодействие с подпроцессом в произвольный момент времени.

Hierarchy

  • IWorkflowSignal

Properties

id info name number parameters processId processTypeName typeId typeName

Properties

Readonly id

id: string

Идентификатор сигнала.

Readonly info

info: IStorage<unknown>

Дополнительная информация для расширений, связанная с сигналом.

Readonly name

name: string

Имя (алиас) сигнала, с которым может быть связана произвольная логика обработки, т.е. сигналы одного типа с разными именами могут обрабатываться по-разному.

Readonly number

number: number

Номер сигнала, по которому может определяться способ его прохождения. Можно задать совместно или вместо имени сигнала name.

Readonly parameters

parameters: IStorage<unknown>

Параметры поступившего сигнала в произвольном формате.

Readonly processId

processId: string

Идентификатор подпроцесса, к которому относится сигнал, или null, если подпроцесс определяется не по идентификатору, а по имени типа processTypeName.

Readonly processTypeName

processTypeName: string

Имя типа подпроцесса, на экземпляр которого отправляется сигнал.

Имя должно быть указано для любых экземпляров сигналов: как для подпроцессов с указанным идентификатором, так и для подпроцессов, существующих в единственном экземпляре для карточки

Если в текущий момент активно несколько подпроцессов данного типа и не был указан идентификатор подпроцесса, то только один экземпляр (случайный) получит сигнал для обработки.

Readonly typeId

typeId: string

Тип сигнала, влияет на способ его обработки.

Readonly typeName

typeName: string

Тип сигнала, влияет на способ его обработки.

Generated using TypeDoc