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

AutodateField
- AutodateField

Implemented by

AutodateField

Index

Methods

columnType

columnType(app): string
ColumnType implements [Field.ColumnType] interface method.
Parameters
- app: App
Returns string
- Defined in types.d.ts:10397

findSetter

findSetter(key): SetterFunc
FindSetter implements the [SetterFinder] interface.
Parameters
- key: string
Returns SetterFunc
- Defined in types.d.ts:10421

getHidden

getHidden(): boolean
GetHidden implements [Field.GetHidden] interface method.

Returns boolean
- Defined in types.d.ts:10385

getId

getId(): string
GetId implements [Field.GetId] interface method.

Returns string
- Defined in types.d.ts:10349

getName

getName(): string
GetName implements [Field.GetName] interface method.

Returns string
- Defined in types.d.ts:10361

getSystem

getSystem(): boolean
GetSystem implements [Field.GetSystem] interface method.

Returns boolean
- Defined in types.d.ts:10373

intercept

intercept(ctx, app, record, actionName, actionFunc): void
Intercept implements the [RecordInterceptor] interface.
Parameters
- ctx: context.Context
- app: App
- record: core.Record
- actionName: string
- actionFunc: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in types.d.ts:10427

prepareValue

prepareValue(record, raw): any
PrepareValue implements [Field.PrepareValue] interface method.
Parameters
- record: core.Record
- raw: any
Returns any
- Defined in types.d.ts:10403

setHidden

setHidden(hidden): void
SetHidden implements [Field.SetHidden] interface method.
Parameters
- hidden: boolean
Returns void
- Defined in types.d.ts:10391

setId

setId(id): void
SetId implements [Field.SetId] interface method.
Parameters
- id: string
Returns void
- Defined in types.d.ts:10355

setName

setName(name): void
SetName implements [Field.SetName] interface method.
Parameters
- name: string
Returns void
- Defined in types.d.ts:10367

setSystem

setSystem(system): void
SetSystem implements [Field.SetSystem] interface method.
Parameters
- system: boolean
Returns void
- Defined in types.d.ts:10379

type

type(): string
Type implements [Field.Type] interface method.

Returns string
- Defined in types.d.ts:10343

validateSettings

validateSettings(ctx, app, collection): void
ValidateSettings implements [Field.ValidateSettings] interface method.
Parameters
- ctx: context.Context
- app: App
- collection: core.Collection
Returns void
- Defined in types.d.ts:10415

validateValue

validateValue(ctx, app, record): void
ValidateValue implements [Field.ValidateValue] interface method.
Parameters
- ctx: context.Context
- app: App
- record: core.Record
Returns void
- Defined in types.d.ts:10409

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.

Interface AutodateField

Hierarchy

Implemented by

Index

Methods

Properties

Methods

columnType

Parameters

app: App

Returns string

findSetter

Parameters

key: string

Returns SetterFunc

getHidden

Returns boolean

getId

Returns string

getName

Returns string

getSystem

Returns boolean

intercept

Parameters

ctx: context.Context

app: App

record: core.Record

actionName: string

actionFunc: (() => void)

Returns void

Returns void

prepareValue

Parameters

record: core.Record

raw: any

Returns any

setHidden

Parameters

hidden: boolean

Returns void

setId

Parameters

id: string

Returns void

setName

Parameters

name: string

Returns void

setSystem

Parameters

system: boolean

Returns void

type

Returns string

validateSettings

Parameters

ctx: context.Context

app: App

collection: core.Collection

Returns void

validateValue

Parameters

ctx: context.Context

app: App

record: core.Record

Returns void

Properties

hidden

id

name

onCreate

onUpdate

presentable

system

Settings

Member Visibility

Theme

On This Page