Interface IntentMessage<BODY>

Represents an intent sent by an application.

The intent is transported to applications that provide a fulfilling capability visible to the sending application.

interface IntentMessage<BODY = any> {
    body?: BODY;
    capability: Capability;
    headers: Map<string, any>;
    intent: Intent;
    retain?: boolean;
}

Type Parameters

  • BODY = any

Hierarchy (View Summary)

Properties

body? capability headers intent retain?

Properties

Optionalbody

body?: BODY

Optional data passed along with the intent.

capability

capability: Capability

Capability that fulfills the intent.

headers

headers: Map<string, any>

Additional information attached to this message.

Header values must be JSON serializable. If no headers are set, the Map is empty.

intent

intent: Intent

Intent that represents this message.

Optionalretain

retain?: boolean

Indicates whether this message is retained on the broker for late subscribers.

Settings

Member Visibility

On This Page

Properties