1. SettingsClientBase

Class SettingsClientBase

Base implementation if ISettingsClient.

Inheritance
object
SettingsClientBase
Implements
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
public abstract class SettingsClientBase : ISettingsClient

Constructors

SettingsClientBase(IMClient)

Initializes a new instance of the SettingsClientBase class.

Declaration
public SettingsClientBase(IMClient client)
Parameters
TypeNameDescription
IMClientclient

The client.

Methods

GetCategoryIdAsync(string)

Gets a category id.

Declaration
public virtual Task<long?> GetCategoryIdAsync(string name)
Parameters
TypeNameDescription
stringname

The name of the category.

Returns
TypeDescription
Task<>long

The category id.

GetSettingAsync(string, string, IEntityLoadConfiguration)

Gets a setting.

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

The category of the setting.

stringname

The name of the setting.

IEntityLoadConfigurationloadConfiguration

The IEntityLoadConfiguration.

Returns
TypeDescription
Task<>IEntity

The IEntity of the setting.

GetSettingsForCategoryAsync(string, IEntityLoadConfiguration)

Gets all settings in a category.

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

The category of the setting.

IEntityLoadConfigurationloadConfiguration

The IEntityLoadConfiguration.

Returns
TypeDescription
Task<>IList<>IEntity

The list of IEntity settings.

Exceptions
TypeCondition
NotFoundException

If the category was not found.

Implements

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