Skip to main content

Interface: $Properties

Properties of a Label.

Extended by​

Properties​

id?​

optional id?: string | null

Opaque identifier assigned by the SDK.

label?​

optional label?: $Properties | null

This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may not apply to this text when used in "label" situations. The payload data section is limited to 400 bytes by default.

Payload only needs to be set on the first use of a given Marker ID; further references to an existing Marker ID reuse existing attributes of the referenced Marker -- i.e. further label payloads are ignored.

Note that it is valid to have distinct Markers (i.e. distinct Marker IDs) in a given workflow execution that carry the same label, provided that they have the distinct ID.