static/jsvm/classes/EmailField.html
EmailField defines "email" type field for storing a single email string address.
The respective zero record field value is empty string.
columnTypegetHiddengetIdgetNamegetSystemprepareValuesetHiddensetIdsetNamesetSystemtypevalidateSettingsvalidateValue
exceptDomainshiddenidnameonlyDomainspresentablerequiredsystem
Optional data: Partial<core.EmailField>ColumnType implements [Field.ColumnType] interface method.
GetHidden implements [Field.GetHidden] interface method.
GetId implements [Field.GetId] interface method.
GetName implements [Field.GetName] interface method.
GetSystem implements [Field.GetSystem] interface method.
PrepareValue implements [Field.PrepareValue] interface method.
SetHidden implements [Field.SetHidden] interface method.
SetId implements [Field.SetId] interface method.
SetName implements [Field.SetName] interface method.
SetSystem implements [Field.SetSystem] interface method.
Type implements [Field.Type] interface method.
ValidateSettings implements [Field.ValidateSettings] interface method.
ValidateValue implements [Field.ValidateValue] interface method.
exceptDomains: string[]
ExceptDomains will require the email domain to NOT be included in the listed ones.
This validator can be set only if OnlyDomains is empty.
hidden: boolean
Hidden hides the field from the API response.
id: string
Id is the unique stable field identifier.
It is automatically generated from the name when adding to a collection FieldsList.
name: string
Name (required) is the unique name of the field.
onlyDomains: string[]
OnlyDomains will require the email domain to be included in the listed ones.
This validator can be set only if ExceptDomains is empty.
presentable: boolean
Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.
required: boolean
Required will require the field value to be non-empty email string.
system: boolean
System prevents the renaming and removal of the field.
OSLightDark
Generated using TypeDoc