FieldsAPI
Defined in: namespaces-core-plugins.ts:450
Plugin-attached fields over fn-93 entities. Field TYPE registration is
declarative-only (manifest) per AD-FN93-51 — there is no
fields.registerType.
fn-93
Methods
Section titled “Methods”listTypes()
Section titled “listTypes()”listTypes(
opts?):Promise<AnyJSONValue[]>
Defined in: namespaces-core-plugins.ts:452
Lists field type definitions. [entities.read]
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<AnyJSONValue[]>
attach()
Section titled “attach()”attach(
attachment):Promise<string>
Defined in: namespaces-core-plugins.ts:454
Attaches a field to an entity type. Returns an attachment token. [entities.field.attach.own]
Parameters
Section titled “Parameters”attachment
Section titled “attachment”Returns
Section titled “Returns”Promise<string>
detach()
Section titled “detach()”detach(
token):Promise<void>
Defined in: namespaces-core-plugins.ts:456
Detaches by token.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
listAttachments()
Section titled “listAttachments()”listAttachments(
entityType,opts?):Promise<AnyJSONValue[]>
Defined in: namespaces-core-plugins.ts:458
Lists field attachments for a type. [entities.read]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
Returns
Section titled “Returns”Promise<AnyJSONValue[]>
registerComputedProvider()
Section titled “registerComputedProvider()”registerComputedProvider(
provider):Promise<string>
Defined in: namespaces-core-plugins.ts:460
Registers a computed-field provider. [entities.computedField.provide]
Parameters
Section titled “Parameters”provider
Section titled “provider”Returns
Section titled “Returns”Promise<string>
setValue()
Section titled “setValue()”setValue(
entityType,entityId,fieldId,value):Promise<void>
Defined in: namespaces-core-plugins.ts:462
Sets a persisted field value. [entities.write]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
entityId
Section titled “entityId”string
fieldId
Section titled “fieldId”string
Returns
Section titled “Returns”Promise<void>
clearValue()
Section titled “clearValue()”clearValue(
entityType,entityId,fieldId):Promise<void>
Defined in: namespaces-core-plugins.ts:464
Clears a persisted field value. [entities.write]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
entityId
Section titled “entityId”string
fieldId
Section titled “fieldId”string
Returns
Section titled “Returns”Promise<void>
getValue()
Section titled “getValue()”getValue(
entityType,entityId,fieldId):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:466
Gets a field value (persisted or computed), or null. [entities.read]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
entityId
Section titled “entityId”string
fieldId
Section titled “fieldId”string
Returns
Section titled “Returns”Promise<AnyJSONValue>