populateAdditionalProps(configData)
Populates the specified object with additional properties that are specific to the current component but are not part of the component’s configuration.
Returns
Not applicable.
Parameters
| Name | Type | Description | Required |
| configData | object | The object that needs to be populated with additional properties. | ✅ |
Usage example
In this example, after the populateAdditionalProps(configData) API
is called, the value of the configProps object is updated based on
the type of the component.
const configProps = { label: 'label-name' }
getPConnect().populateAdditionalProps(configProps);The possible keys added to the configProps object are:
configObject.pageMessages (string)- This key contains page messages that are added for the case_view component.configObject.validatemessage (string)- This key contains validation messages for components that are editable.configObject.infoMessage (string)- This key contains warning messages for components that are editable.configObject.status (string)- This key contains the string values that indicate the type of the message. The values can be either error or warning.configObject.httpMessages (string)- This key contains application level HTTP messages.configObject.caseMessages (string)- This key contains cases level messages.configObject.stages (object)- This key contains information about stages.configObject.fieldMetadata (object)- This key contains the information about the additional configuration that is configured in PRPC.
Previous topic isEditable() Next topic registerAdditionalProps(additionalMeta)