Skip to main content

Module interaction

Module interaction 

Source
Expand description

Persistent interactions: cards, confirmations, selections (spec §15).

An interaction is a durable, server-owned record. The client only ever sends back an interaction id, an option id and the case revision it saw (I7); the meaning of the click is the StoredInteractionAction persisted with the option. validate_response is the pure gate every response passes through before anything executes.

Structs§

AcceptedResponse
A response that passed every §15.5 rule.
Interaction
A persisted interaction (spec §15.1).
InteractionOption
A stored option (spec §15.3).
InteractionOptionView
Client-facing option: no server action.
InteractionPayload
Immutable content of an interaction (spec §15.1).
InteractionSpec
What a reducer or workflow asks the engine to create (spec §13.3, I6).
InteractionView
Client-facing projection of an interaction (spec §18.1).
ReviewDiffEntry
One line of a review card: a field before and after the proposed change.

Enums§

ActionClass
What a stored option authorizes when it is chosen (spec §15.3).
FieldValue
One side of a field change: absent, or an explicit JSON value.
FreeformPolicy
Whether an option accepts free text (spec §15.5).
InteractionKind
The shape of an interaction (spec §15.2).
InteractionRejection
Why a response was not accepted (spec §15.5).
InteractionStatus
Lifecycle status of an interaction (spec §15.4).
OptionStyle
Visual emphasis of an option, for clients.
StoredInteractionAction
The server-side meaning of an option (spec §15.3). Never supplied by the client.
TextResolutionPolicy
Whether and how typed text may resolve an interaction (spec §15.7).

Functions§

validate_response
Pure validation of a client response against the stored interaction (spec §15.5).