AgentforceUIAPIObjectInfo

A data structure that represents object information from the UI API in Agentforce conversations. It provides comprehensive object metadata including field definitions, relationship information, layout capabilities, and display properties for rendering object information in conversation interfaces.

PropertyTypeDescription
apiNameStringThe API name of the object
associateEntityTypeString?Associated entity type
associateParentEntityString?Associated parent entity
childRelationships[AgentforceUIAPIChildRelationship]Child relationships
compactLayoutableBool?Whether the object supports compact layout
createableBool?Whether the object can be created
customBoolWhether the object is custom
defaultRecordTypeIdString?Default record type ID
deletableBoolWhether the object can be deleted
fields[String: AgentforceUIAPIFields]Field definitions
keyPrefixString?Key prefix for the object
labelStringDisplay label for the object
labelPluralStringPlural display label
layoutableBoolWhether the object supports layout
mruEnabledBoolWhether most recently used is enabled
nameFields[String]Name fields for the object
queryableBoolWhether the object is queryable
recordTypeInfos[String: AgentforceUIAPIRecordTypeInfo]Record type information
searchableBoolWhether the object is searchable
searchLayoutableBool?Whether the object supports search layout
themeInfoAgentforceUIAPIThemeInfo?Theme information
updateableBoolWhether the object can be updated
MethodSignatureDescription
initinit(apiName:associateEntityType:associateParentEntity:childRelationships:compactLayoutable:createable:custom:defaultRecordTypeId:deletable:fields:keyPrefix:label:labelPlural:layoutable:mruEnabled:nameFields:queryable:recordTypeInfos:searchable:searchLayoutable:themeInfo:updateable:)Initializes a new object info with all properties
init(from:)init(from: Decoder) throwsInitializes from a decoder for JSON deserialization