Interface: FieldTypeRegistryApi

FieldTypeRegistryApi.FieldTypeRegistryApi

Description

Contains APIs to allow developers to register their own custom field types and query field data

Properties

• getField
• getFieldNamePerArtifactId
• getFieldTypeIdForField
• registerFieldWithFieldType
• registerSupplementalFieldData

Properties

getField

• getField: (fieldName: string) => undefined | FieldTypeRegistryEntry

Type declaration

• (fieldName): undefined | FieldTypeRegistryEntry

Parameters

Name	Type	Description
fieldName	string	The name of the field to lookup in the registry

Returns

undefined | FieldTypeRegistryEntry

Returns a FieldTypeRegistryEntry object if the field name is found, otherwise undefined

Description

Allows the developer to look up a field type and stored supplemental data via name

getFieldNamePerArtifactId

• getFieldNamePerArtifactId: (fieldArtifactId: number) => undefined | string

Type declaration

• (fieldArtifactId): undefined | string

Parameters

Name	Type	Description
fieldArtifactId	number	The artifact ID of the field to lookup

Returns

undefined | string

Returns the field name of the field if found, otherwise undefined

Description

Allows the developer to retrieve the field name via Artifact ID

getFieldTypeIdForField

• getFieldTypeIdForField: (fieldName: string) => undefined | number

Type declaration

• (fieldName): undefined | number

Parameters

Name	Type	Description
fieldName	string	The name of the field to lookup

Returns

undefined | number

Returns the number representation of the field type if found, otherwise undefined

Description

Allows the developer to retrieve the number representation of the field type via name

registerFieldWithFieldType

• registerFieldWithFieldType: (fieldName: string, fieldTypeId: number, artifactId: number, category: string) => void

Type declaration

• (fieldName, fieldTypeId, artifactId, category): void

Parameters

Name	Type	Description
fieldName	string	The name of the field to register
fieldTypeId	number	Numeric representation of the field type
artifactId	number	An ID to identify the field by
category	string	A category to associate the field with (can be an empty string)

Returns

void

Description

Allows the developer to register a new field with the specified parameters

registerSupplementalFieldData

• registerSupplementalFieldData: (fieldName: string, data: any) => void

Type declaration

• (fieldName, data): void

Parameters

Name	Type	Description
fieldName	string	The name of the field to lookup
data	any	The additional data to attach to the field

Returns

void

Description

Allows the developer to attach additional data to a field in the registry