fields

Documentation

Index

• type AutoID
• type AvatarOrLogo
• type Boolean
• type CompositeType
• type Date
• type DateTime
• type Email
• type ExtractSingleRecord
• type FieldBase
• type File
• type Formula
• type Lookup
• type MobileNumber
• type Multilingual
• type Number
• type Option
• type OptionItem
• type ReferenceField
• type RichText
• type SortCondition
• type Text

Types

type AutoID

type AutoID struct {
	FieldBase
	GenerateMethod string `json:"generateMethod"` // "random"|"incremental"
	DigitsNumber   int64  `json:"digitsNumber"`
	Prefix         string `json:"prefix"`
	Suffix         string `json:"suffix"`
}

type AvatarOrLogo

type AvatarOrLogo struct {
	FieldBase
	DisplayStyle string `json:"displayStyle"`
}

type Boolean

type Boolean struct {
	FieldBase
	DescriptionWhenTrue  structs.I18ns `json:"descriptionWhenTrue"`
	DescriptionWhenFalse structs.I18ns `json:"descriptionWhenFalse"`
	DefaultValue         bool          `json:"defaultValue"`
}

type CompositeType

type CompositeType struct {
	FieldBase
	CompositeTypeAPIName string                 `json:"compositeTypeAPIName"`
	Required             bool                   `json:"required"`
	Multiple             bool                   `json:"multiple"`
	SubFields            map[string]interface{} `json:"subFields"`
}

type Date

type Date struct {
	FieldBase
	Required bool `json:"required"`
}

type DateTime

type DateTime struct {
	FieldBase
	Required bool `json:"required"`
}

type Email

type Email struct {
	FieldBase
	Required bool `json:"required"`
	Unique   bool `json:"unique"`
}

type ExtractSingleRecord

type ExtractSingleRecord struct {
	FieldBase
	CompositeTypeAPIName string                 `json:"compositeTypeAPIName"`
	SubFields            map[string]interface{} `json:"subFields"`
	Filter               *structs.Criterion     `json:"filter"`
	SortConditions       *structs.Sorts         `json:"sortConditions"`
	RecordPosition       int64                  `json:"recordPosition"`
}

type FieldBase

type FieldBase struct {
	Type    string        `json:"type"`
	APIName string        `json:"apiName"`
	Label   structs.I18ns `json:"label"`
}

type File

type File struct {
	FieldBase
	Required  bool     `json:"required"`
	Multiple  bool     `json:"multiple"`
	FileTypes []string `json:"fileTypes"`
}

type Formula

type Formula struct {
	FieldBase
	ReturnType string        `json:"returnType"`
	Formula    structs.I18ns `json:"formula"`
}

type Lookup

type Lookup struct {
	FieldBase
	Required       bool            `json:"required"`
	Multiple       bool            `json:"multiple"`
	ObjectAPIName  string          `json:"objectAPIName"`
	Hierarchy      bool            `json:"hierarchy"`
	DisplayStyle   string          `json:"displayStyle"`
	SortConditions []SortCondition `json:"sortConditions"`
	Filter         []interface{}   `json:"filter"` // TODO 未返回
}

type MobileNumber

type MobileNumber struct {
	FieldBase
	Required bool `json:"required"`
	Unique   bool `json:"unique"`
}

type Multilingual

type Multilingual struct {
	FieldBase
	Required      bool  `json:"required"`
	Unique        bool  `json:"unique"`
	CaseSensitive bool  `json:"caseSensitive"`
	Multiline     bool  `json:"multiline"`
	MaxLength     int64 `json:"maxLength"`
}

type Number

type Number struct {
	FieldBase
	Required            bool `json:"required"`
	Unique              bool `json:"unique"`
	DisplayAsPercentage bool `json:"displayAsPercentage"`
	DecimalPlacesNumber int  `json:"decimalPlacesNumber"`
}

type Option

type Option struct {
	FieldBase
	Required            bool          `json:"required"`
	Multiple            bool          `json:"multiple"`
	OptionSource        string        `json:"optionSource"` // 暴露给开发者：custom, global; 底层存储：local,  global
	GlobalOptionAPIName string        `json:"globalOptionAPIName"`
	OptionList          []*OptionItem `json:"optionList"`
}

type OptionItem

type OptionItem struct {
	Label       structs.I18ns `json:"label"`
	APIName     string        `json:"apiName"`
	Description structs.I18ns `json:"description"`
	Color       string        `json:"color"`
	Active      bool          `json:"active"`
}

type ReferenceField

type ReferenceField struct {
	FieldBase
	GuideFieldAPIName string `json:"guideFieldAPIName"`
	FieldAPIName      string `json:"fieldAPIName"`
}

type RichText

type RichText struct {
	FieldBase
	Required  bool `json:"required"`  // 默认值：false
	MaxLength int  `json:"maxLength"` // 默认值：1000
}

type SortCondition

type SortCondition struct {
	FieldAPIName string `json:"fieldAPIName"`
	Sort         string `json:"sort"` //"asc"|"desc"
}

type Text

type Text struct {
	FieldBase
	Required        bool   `json:"required"`
	Unique          bool   `json:"unique"`
	CaseSensitive   bool   `json:"caseSensitive"`
	Multiline       bool   `json:"multiline"`
	MaxLength       int64  `json:"maxLength"`
	ValidationRegex string `json:"validationRegex"`
	ErrorMsg        string `json:"errorMsg"`
}