Skip to content

Type Alias: FormAction

ts
type FormAction =
  | {
  field: string;
  type: "set_field";
  value: string;
}
  | {
  control: FormControl;
  field: string;
  options?: FormFieldOption[];
  presentation?: AskPresentation;
  prompt?: string;
  type: "ask_field";
}
  | {
  field: string;
  type: "focus_field";
}
  | {
  type: "submit";
}
  | {
  summary?: string;
  type: "complete";
}
  | {
  actions?: StageAction[];
  cards: ExperienceCard[];
  heading?: string;
  id: string;
  intro?: string;
  receipt?: ReceiptRow[];
  type: "show_cards";
}
  | {
  actions?: SheetAction[];
  facts?: string[];
  id: string;
  imageId?: string;
  imageUrl?: string;
  kind: SheetKind;
  link?: {
     label: string;
     url: string;
  };
  note?: string;
  receipt?: ReceiptRow[];
  steps?: string[];
  subtitle?: string;
  summary?: string;
  title: string;
  type: "show_sheet";
};

What the SDK should do to the real form after rendering the agent's text.

Proprietary. All rights reserved.