Interface AutodateField

AutodateField defines an "autodate" type field, aka. field which datetime value could be auto set on record create/update.

This field is usually used for defining timestamp fields like "created" and "updated".

Requires either both or at least one of the OnCreate or OnUpdate options to be set.

Hierarchy

Implemented by

Methods

columnType findSetter getHidden getId getName getSystem intercept prepareValue setHidden setId setName setSystem type validateSettings validateValue

Properties

hidden id name onCreate onUpdate presentable system

Methods

columnType

  • ColumnType implements [Field.ColumnType] interface method.

    Parameters

    Returns string

findSetter

getHidden

  • GetHidden implements [Field.GetHidden] interface method.

    Returns boolean

getId

  • GetId implements [Field.GetId] interface method.

    Returns string

getName

  • GetName implements [Field.GetName] interface method.

    Returns string

getSystem

  • GetSystem implements [Field.GetSystem] interface method.

    Returns boolean

intercept

  • Intercept implements the [RecordInterceptor] interface.

    Parameters

    Returns void

prepareValue

  • PrepareValue implements [Field.PrepareValue] interface method.

    Parameters

    Returns any

setHidden

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

setId

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

setName

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

setSystem

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

type

  • Type implements [Field.Type] interface method.

    Returns string

validateSettings

validateValue

Properties

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

name

name: string

Name (required) is the unique name of the field.

onCreate

onCreate: boolean

OnCreate auto sets the current datetime as field value on record create.

onUpdate

onUpdate: boolean

OnUpdate auto sets the current datetime as field value on record update.

presentable

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

system

system: boolean

System prevents the renaming and removal of the field.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc