Class ApplicationSettingsSystem

Inheritance Relationships

Base Type

Class Documentation

class ApplicationSettingsSystem : public csp::systems::SystemBase

Public facing system that allows interfacing with Magnopus Connected Services’ application settings service.

Public Functions

void GetSettingsByContext(const csp::common::String &ApplicationName, const csp::common::String &Context, const csp::common::Optional<csp::common::Array<csp::common::String>> &Keys, ApplicationSettingsResultCallback Callback)

Asynchronously retrieves application settings for a specific context.

Parameters
  • ApplicationNamecsp::common::String : The name of the application for which settings are requested.

  • Contextcsp::common::String : The specific context whose settings should be retrieved.

  • Keys – csp::common::Optional<csp::common::Array<csp::common::String>> : Array of setting keys to retrieve. If not provided, all settings for the context are returned.

  • Callback – ApplicationSettingsResultCallback : Callback when asynchronous task finishes.

void GetSettingsByContextAnonymous(const csp::common::String &Tenant, const csp::common::String &ApplicationName, const csp::common::String &Context, const csp::common::Optional<csp::common::Array<csp::common::String>> &Keys, ApplicationSettingsResultCallback Callback)

Asynchronously retrieves application settings for a specific context without requiring authentication.

Parameters
  • Tenantcsp::common::String : The tenant identifier under which the application and settings are scoped.

  • ApplicationNamecsp::common::String : The name of the application for which settings are requested.

  • Contextcsp::common::String : The specific context whose settings should be retrieved.

  • Keys – csp::common::Optional<csp::common::Array<csp::common::String>> : Array of setting keys to retrieve. If not provided, all settings for the context are returned.

  • Callback – ApplicationSettingsResultCallback : Callback when asynchronous task finishes.