Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data CreateFormData = CreateFormData' {}
- newCreateFormData :: FormDataTypeConfig -> FormActionType -> Text -> Text -> FormStyle -> CreateFormData
- createFormData_cta :: Lens' CreateFormData (Maybe FormCTA)
- createFormData_tags :: Lens' CreateFormData (Maybe (HashMap Text Text))
- createFormData_dataType :: Lens' CreateFormData FormDataTypeConfig
- createFormData_fields :: Lens' CreateFormData (HashMap Text FieldConfig)
- createFormData_formActionType :: Lens' CreateFormData FormActionType
- createFormData_name :: Lens' CreateFormData Text
- createFormData_schemaVersion :: Lens' CreateFormData Text
- createFormData_sectionalElements :: Lens' CreateFormData (HashMap Text SectionalElement)
- createFormData_style :: Lens' CreateFormData FormStyle
Documentation
data CreateFormData Source #
Represents all of the information that is required to create a form.
See: newCreateFormData
smart constructor.
CreateFormData' | |
|
Instances
:: FormDataTypeConfig | |
-> FormActionType | |
-> Text | |
-> Text | |
-> FormStyle | |
-> CreateFormData |
Create a value of CreateFormData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cta:CreateFormData'
, createFormData_cta
- The FormCTA
object that stores the call to action configuration for
the form.
$sel:tags:CreateFormData'
, createFormData_tags
- One or more key-value pairs to use when tagging the form data.
$sel:dataType:CreateFormData'
, createFormData_dataType
- The type of data source to use to create the form.
$sel:fields:CreateFormData'
, createFormData_fields
- The configuration information for the form's fields.
$sel:formActionType:CreateFormData'
, createFormData_formActionType
- Specifies whether to perform a create or update action on the form.
$sel:name:CreateFormData'
, createFormData_name
- The name of the form.
$sel:schemaVersion:CreateFormData'
, createFormData_schemaVersion
- The schema version of the form.
$sel:sectionalElements:CreateFormData'
, createFormData_sectionalElements
- The configuration information for the visual helper elements for the
form. These elements are not associated with any data.
$sel:style:CreateFormData'
, createFormData_style
- The configuration for the form's style.
createFormData_cta :: Lens' CreateFormData (Maybe FormCTA) Source #
The FormCTA
object that stores the call to action configuration for
the form.
createFormData_tags :: Lens' CreateFormData (Maybe (HashMap Text Text)) Source #
One or more key-value pairs to use when tagging the form data.
createFormData_dataType :: Lens' CreateFormData FormDataTypeConfig Source #
The type of data source to use to create the form.
createFormData_fields :: Lens' CreateFormData (HashMap Text FieldConfig) Source #
The configuration information for the form's fields.
createFormData_formActionType :: Lens' CreateFormData FormActionType Source #
Specifies whether to perform a create or update action on the form.
createFormData_name :: Lens' CreateFormData Text Source #
The name of the form.
createFormData_schemaVersion :: Lens' CreateFormData Text Source #
The schema version of the form.
createFormData_sectionalElements :: Lens' CreateFormData (HashMap Text SectionalElement) Source #
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
createFormData_style :: Lens' CreateFormData FormStyle Source #
The configuration for the form's style.