UpdateConfiguration

Common::Configuration::UpdateConfiguration

Function UpdateConfiguration 

Source 
pub fn UpdateConfiguration(
    Key: String,
    ValueToSet: Value,
    TargetAsU32: u32,
    OverridesValue: Value,
    ScopeToLanguage: Option<bool>,
) -> ActionEffect<Arc<dyn ConfigurationProvider>, CommonError, ()>
Expand description

Creates an effect that, when executed, will update a configuration value at a specific key and target scope (e.g., User or WorkSpace settings).

It uses the ConfigurationProvider capability from the environment to perform the operation, which will typically involve modifying a settings.json file on disk.

§Parameters

  • Key: The dot-separated configuration key to update.
  • ValueToSet: The new serde_json::Value to set for the key.
  • TargetAsU32: The integer representation of the ConfigurationTarget enum, used for cross-language serialization.
  • OverridesValue: A DTO specifying scope overrides (e.g., for a specific language).
  • ScopeToLanguage: An optional flag related to language-specific settings.

§Returns

An ActionEffect that resolves to () on success.