updateFieldValue(propName, value, options)

Updated on July 20, 2021

Dispatches the SET_PROPERTY event on a specified control to store a specified value in the Redux Store.

This API also deletes the error messages of the control by calling the clearMessages(config) API in the MessageManager module.

Returns

Not applicable.

Name	Type	Description	Required
propName	string	The name of the control whose value must be stored in the Redux Store.	✅
value	any	The value of the control to be stored in the Redux Store.	✅
options	object	The JavaScript object containing the properties to enhance the functionality of this API.	❌

The following table contains the properties of the options object:

Name	Type	Description	Required
removePropertyFromChangedList	boolean	The flag that removes the entry of the property from the `changedPropertyList`. Note: The default value is false. Set this property to true to remove the entry of the property from the `changedPropertyList`.	❌
isArrayDeepMerge	boolean	The flag that decides if the values within an array or object must be deep merged to the Redux Store. Note: The default value is true. Set this property to true to deep merge the values to the Redux Store.	❌

In this example, the API stores the value passed in the Redux Store as triggered by the control.

getPConnect().getActionsApi().updateFieldValue(propName, value);

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center