Interface PublishMessageRequest<Variables>

interface PublishMessageRequest<Variables> {
    correlationKey: string;
    messageId?: string;
    name: string;
    tenantId?: string;
    timeToLive?: MaybeTimeDuration;
    variables?: Variables;
}

Type Parameters

Properties

correlationKey messageId? name tenantId? timeToLive? variables?

Properties

correlationKey

correlationKey: string

The value to match with the field specified as "Subscription Correlation Key" in BPMN

Optional messageId

messageId?: string

Unique ID for this message

name

name: string

Should match the "Message Name" in a BPMN Message Catch

Optional tenantId

tenantId?: string

the tenantId of the message

Optional timeToLive

timeToLive?: MaybeTimeDuration

The number of seconds for the message to buffer on the broker, awaiting correlation. Omit or set to zero for no buffering.

Optional variables

variables?: Variables

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc