Class SettingsClientBase

Base implementation if ISettingsClient.

Inheritance

object

SettingsClientBase

public abstract class SettingsClientBase : ISettingsClient

Initializes a new instance of the SettingsClientBase class.

public SettingsClientBase(IMClient client)

Type	Name	Description
IMClient	client	The client.

Gets a category id.

public virtual Task<long?> GetCategoryIdAsync(string name)

Type	Name	Description
string	name	The name of the category.

Type	Description
Task<>long	The category id.

Gets a setting.

public Task<IEntity> GetSettingAsync(string category, string name, IEntityLoadConfiguration loadConfiguration = null)

Type	Name	Description
string	category	The category of the setting.
string	name	The name of the setting.
IEntityLoadConfiguration	loadConfiguration	The IEntityLoadConfiguration.

Type	Description
Task<>IEntity	The IEntity of the setting.

Gets all settings in a category.

public Task<IList<IEntity>> GetSettingsForCategoryAsync(string category, IEntityLoadConfiguration loadConfiguration = null)

Type	Name	Description
string	category	The category of the setting.
IEntityLoadConfiguration	loadConfiguration	The IEntityLoadConfiguration.

Type	Description
Task<>IList<>IEntity	The list of IEntity settings.

Type	Condition
NotFoundException	If the category was not found.

If you have suggestions for improving this article, let us know!