Skip to content

Interface: FormFieldSnapshot

One real form control as the SDK saw it when the message was sent.

Properties

PropertyTypeDescription
constraints?FormFieldConstraints-
context?stringDeveloper hint from the field's data-nam-context attribute.
help?stringVisitor-facing help line from data-nam-help, shown under the question.
idstringDOM id, else name. Every FormAction.field must echo one exactly.
kind| "number" | "select" | "text" | "email" | "tel" | "date" | "textarea" | "radio" | "checkbox"-
labelstring-
locked?booleanConsent controls: the agent may focus these, never set or ask for them.
options?FormFieldOption[]select, radio and checkbox groups only.
requiredboolean-
sensitive?booleanThe field exists but its value is withheld: card, CVC, one-time code, SSN. Always locked as well, so the agent can point at it and never read or fill it.
validboolean | nullBrowser validity plus mask completeness; null until something has validated it.
validationMessage?string-
valuestring'' when empty, never null.

Proprietary. All rights reserved.