Interface ReferenceBody

All Known Subinterfaces:
ReferenceBody.TextBody
All Known Implementing Classes:
OpcReferenceBody, ReferenceBody.TextBody.RenderedText

public sealed interface ReferenceBody permits ReferenceBody.TextBody
The resolved payload of one prompt reference — what a PromptAssist.Option.Insert's supplier produces at submit time and the framework attaches to the outbound message.

ReferenceBody.TextBody.of(String) and ReferenceBody.TextBody.ofFields(Consumer) cover one-off bodies whose data is never read back: free-form prose and anonymous Key: value text respectively. A provider that needs its data back (e.g. an OPC composer wanting the node id and server) implements ReferenceBody.TextBody with its own record instead.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    A text-modality body — the wire form is the exact text embedded between <reference> tags.