Interface IField

Represents a field set on an entry.

interface IField {
    fieldType?: FieldType;
    groupId?: number;
    hasMoreValues?: boolean;
    id?: number;
    isMultiValue?: boolean;
    isRequired?: boolean;
    name?: string;
    values?: string[];
}

Implemented by

Properties

fieldType? groupId? hasMoreValues? id? isMultiValue? isRequired? name? values?

Properties

OptionalfieldType

fieldType?: FieldType

The type of the field. The possible field types are listed below.

OptionalgroupId

groupId?: number

The group id of the multi value field group. If the field is not a part of a multi value field group, then there is no group id.

OptionalhasMoreValues

hasMoreValues?: boolean

A boolean indicating if there are more field values.

Optionalid

id?: number

The ID of the field.

OptionalisMultiValue

isMultiValue?: boolean

A boolean indicating if the represented field supports multiple values.

OptionalisRequired

isRequired?: boolean

A boolean indicating if the represented field must have a value set on entries assigned to a template that the field is a member of.

Optionalname

name?: string

The name of the field.

Optionalvalues

values?: string[]

The values assigned to the field.

Settings

Member Visibility

On This Page

Properties