Interface IConfigService

Namespace

Homa.Sdk.Configuration

Assembly

Homa.Sdk.Configuration.dll

An interface for accessing config objects.

public interface IConfigService

Properties

IsInitialized

Indicates whether the configuration service has been successfully initialized.

bool IsInitialized { get; }

Property Value

bool

Methods

Deinitialize()

Deinitializes the configuration service, releasing any resources and resetting the initialization state.

void Deinitialize()

GetHandle<T>()

Retrieves a Config handle for the specified config type.

IConfigHandle<T> GetHandle<T>()

Returns

IConfigHandle<T>

An instance of IConfigHandle<T> that represents the config handle for the specified type.

Type Parameters

T

The type of the config object.

Initialize()

Initializes the configuration service.

Task Initialize()

Returns

Task

A task representing the asynchronous initialization operation.

RequestCatalogUpdate()

Schedules a catalog update to it's latest version.
For runtime this includes applying patches from all patch sources.
For the editor, it means loading the catalog from the disk.

void RequestCatalogUpdate()

Events

Initialized

Event triggered when the configuration service is successfully initialized.

event Action Initialized

Event Type

Action

See Also

ConfigAttribute