a!refreshVariable( value, refreshAlways, refreshInterval, refreshOnReferencedVarChange, refreshOnVarChange, refreshAfter )
The configuration for a specific local variable for use within a!localVariables(). When used within an interface, the value of the variable can be refreshed under a variety of conditions. When used outside of an interface, all refresh properties are ignored.
See also: Local Variables
Keyword | Type | Description |
---|---|---|
|
Any Type |
The value of the local variable when it is created and what the variable is set to each time it is refreshed in an interface. |
|
Boolean |
When |
|
Number (Decimal) |
How often the variable value gets refreshed in minutes. When null, the variable will not be refreshed on an interval. Because the variable is periodically refreshed, you cannot update its value by saving into it. Valid values include 0.5, 1, 2, 3, 4, 5, 10, 30, 60. |
|
Boolean |
When |
|
Any Type |
Refreshes the value of the local variable each time any of these specific variables change. This allows you to refresh the value when a variable that is not referenced within the value parameter is updated. |
|
List of Text String |
Refreshes the value of the local variable after a record action, such as a related action or a record list action configured within a record type, completes from a dialog window within the Record Action Component. Instead of requiring the entire page to reload, this parameter allows you to refresh a local variable value on an interface after a record action completes. Valid values include |
Any Type
You can define refreshOnVarChange
either using a single variable (e.g. refreshOnVarChange: local!var1
) or a list of variables (e.g. refreshOnVarChange: {local!var1, local!var2}
).
For more information about how to use a!localVariables
and a!refreshVariable
, including detailed examples, see Local Variables and Record Action Component. The Configuring Refresh Behavior section contains specific information about the different parameters of a!refreshVariable
and how to use them.
a!refreshVariable() Function