FieldDefinition

final public class FieldDefinition : CustomStringConvertible, CustomDebugStringConvertible, ExtendedEquatable

Immutable Model for a field on the registration form for an entity.

  • Field name

    Declaration

    Swift

    public internal(set) var name: String? {
      get
      }
  • Is a required (mandatory) field

    Declaration

    Swift

    public internal(set) var required: Bool? {
      get
      }
  • Localised field label

    Declaration

    Swift

    public internal(set) var label: String? {
      get
      }
  • Localised field hint

    Declaration

    Swift

    public internal(set) var hint: String? {
      get
      }
  • Field Input type

    Declaration

    Swift

    public internal(set) var inputType: FieldDefinition.InputType? {
      get
      }
  • Is a read only field

    Declaration

    Swift

    public internal(set) var readOnly: Bool? {
      get
      }
  • Is a secured field

    Declaration

    Swift

    public internal(set) var secured: Bool? {
      get
      }
  • Field option values

    Declaration

    Swift

    public internal(set) var options: [OptionValue]? {
      get
      }
  • Input Type options

    • text: text
    • emailAddress: email
    • phoneNumber: phone number
    • selection: selection (multi option field)
    • countryCode: country code list
    • numeric: numeric
    • date­: date
    • boolean: boolean
    See more

    Declaration

    Swift

    public enum InputType : String
  • CustomStringConvertible

    Declaration

    Swift

    public var description: String { get }
  • CustomDebugStringConvertible

    Declaration

    Swift

    public var debugDescription: String { get }