Class Config

Namespace

Homa.Sdk.Configuration

Assembly

Homa.Sdk.Configuration.dll

A static interface for accessing the config objects at runtime.

public static class Config

Inheritance

object

Config

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

IsInitialized

Returns true once the Configuration module has been initialized.

public static bool IsInitialized { get; }

Property Value

bool

See Also

Initialized

Service

Provides access to the underlying configuration service.

public static IConfigService Service { get; }

Property Value

IConfigService

Remarks

To create and initialize the service, use Initialize() method.

See Also

IConfigService

Methods

Create()

Create and load the default catalog.

public static void Create()

Deinitialize()

Deinitializes the Configuration module. This method is automatically called by Homa SDK on application quit.

public static void Deinitialize()

GetHandle<T>()

Retrieves a handle with a config object of type T.

public static IConfigHandle<T> GetHandle<T>()

Returns

IConfigHandle<T>

A handle with the config object of type T.

Type Parameters

T

The type of the config object stored in the handle. Config types must use the ConfigAttribute.

Exceptions

ConfigNotInitializedException

Thrown when trying to access Config before it has been initialized.

Initialize()

Initializes the Configuration module. This method is automatically called by Homa SDK.

public static Task Initialize()

Returns

Task

RequestCatalogUpdate()

Schedules a catalog update to its latest version.

public static void RequestCatalogUpdate()

See Also

RequestCatalogUpdate()

Events

Initialized

Is invoked once the Configuration module has been initialized.

public static event Action Initialized

Event Type

Action

See Also

IsInitialized

See Also

ConfigAttribute