Interface ISystemService

Namespace

Oqtane.Services

Assembly

Oqtane.Client.dll

Service to retrieve and update system information.

public interface ISystemService

Methods

GetIconsAsync()

returns a key-value dictionary with default system icons

Task<Dictionary<string, string>> GetIconsAsync()

Returns

Task<Dictionary<string, string>>

GetSystemInfoAsync()

returns a key-value dictionary with the current system configuration information

Task<Dictionary<string, object>> GetSystemInfoAsync()

Returns

Task<Dictionary<string, object>>

GetSystemInfoAsync(string)

returns a key-value dictionary with the current system information - "environment" or "configuration"

Task<Dictionary<string, object>> GetSystemInfoAsync(string type)

Parameters

type string

Returns

Task<Dictionary<string, object>>

GetSystemInfoAsync(string, object)

returns a config value

Task<object> GetSystemInfoAsync(string settingKey, object defaultValue)

Parameters

settingKey string

defaultValue object

Returns

Task<object>

UpdateSystemInfoAsync(Dictionary<string, object>)

Updates system information

Task UpdateSystemInfoAsync(Dictionary<string, object> settings)

Parameters

settings Dictionary<string, object>

Returns

Task