Class SettingsClientBase
Base implementation if ISettingsClient.
Inheritance
object
SettingsClientBase
Implements
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ModelsClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public abstract class SettingsClientBase : ISettingsClientConstructors
SettingsClientBase(IMClient)
Initializes a new instance of the SettingsClientBase class.
Declaration
RequestResponse
public SettingsClientBase(IMClient client)Parameters
| Type | Name | Description |
|---|---|---|
| IMClient | client |
The client. |
Methods
GetCategoryIdAsync(string)
Gets a category id.
Declaration
RequestResponse
public virtual Task<long?> GetCategoryIdAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
The name of the category. |
Returns
| Type | Description |
|---|---|
| Task<>long |
The category id. |
GetSettingAsync(string, string, IEntityLoadConfiguration)
Gets a setting.
Declaration
RequestResponse
public Task<IEntity> GetSettingAsync(string category, string name, IEntityLoadConfiguration loadConfiguration = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | category |
The category of the setting. |
| string | name |
The name of the setting. |
| IEntityLoadConfiguration | loadConfiguration |
Returns
GetSettingsForCategoryAsync(string, IEntityLoadConfiguration)
Gets all settings in a category.
Declaration
RequestResponse
public Task<IList<IEntity>> GetSettingsForCategoryAsync(string category, IEntityLoadConfiguration loadConfiguration = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | category |
The category of the setting. |
| IEntityLoadConfiguration | loadConfiguration |
Returns
Exceptions
| Type | Condition |
|---|---|
| NotFoundException |
If the category was not found. |