Struct InteractionPayload 

pub struct InteractionPayload {
    pub title: LocalizedText,
    pub body: Option<LocalizedText>,
    pub options: Vec<InteractionOption>,
    pub review_entries: Vec<ReviewDiffEntry>,
    pub freeform_prompt: Option<LocalizedText>,
    pub metadata: Value,
}

Immutable content of an interaction (spec §15.1).

Fields

title: LocalizedText

Title copy.

body: Option<LocalizedText>

Body copy.

options: Vec<InteractionOption>

Stored options.

review_entries: Vec<ReviewDiffEntry>

Diff entries for review cards.

freeform_prompt: Option<LocalizedText>

Prompt for free-form interactions.

metadata: Value

Application metadata (rendering hints, preview hash…).

Implementations

impl InteractionPayload

pub fn new(title: impl Into<LocalizedText>) -> Self

Builds a payload with only a title.

pub fn with_body(self, body: impl Into<LocalizedText>) -> Self

Sets the body.

pub fn with_option(self, option: InteractionOption) -> Self

Appends an option.

pub fn with_review_entry(self, entry: ReviewDiffEntry) -> Self

Appends a review entry.

pub fn with_metadata(self, metadata: Value) -> Self

Sets metadata.

pub fn hash(&self) -> Result<Digest, HashError>

BLAKE3 over the canonical JSON of the payload. Stored on the interaction and embedded in CommandOrigin::ConfirmedInteraction so a command can prove which content the user confirmed.

pub fn option(&self, id: &OptionId) -> Option<&InteractionOption>

Finds a stored option.

pub fn option_ids(&self) -> Vec<OptionId>

Identifiers of all options.

pub fn with_freeform_prompt(self, prompt: impl Into<LocalizedText>) -> Self

Sets the free-form prompt.

pub fn validate_for( &self, kind: InteractionKind, ) -> Result<(), InteractionSpecError>

Checks that a card of this kind can actually be answered (I6).

A user-owned phase whose card carries no usable option is a dead end: the case blocks on an answer nobody can give. The rules are:

• option ids are unique, whatever the kind;
• Boolean has exactly two options;
• SingleSelect, SelectTarget and ResolveValidationError have at least one option;
• ConfirmCommand and ReviewChanges have at least one option that authorizes commands and one that declines, so refusing is always possible; ReviewChanges also has at least one diff entry;
• Reauthenticate and ExternalSignature have at least one option that authorizes commands, since their whole purpose is to carry that authority;
• Freeform has a prompt and an option that requires free text;
• MultiSelect is refused outright: the input protocol carries one option id (InteractionResponse::option_id), so a persisted multi-select card could only ever be answered as a single select.

Trait Implementations

impl Clone for InteractionPayload

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InteractionPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InteractionPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InteractionPayload

impl PartialEq for InteractionPayload

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for InteractionPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InteractionPayload