Interface ISettingsClient
Version: 4.0
Client for fetching setting and category entities.
Namespace: StylelabsStylelabs.MSdkClients
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public interface ISettingsClientMethods
GetCategoryIdAsync(string)
Gets the id of a category by name.
Declaration
RequestResponse
Task<long?> GetCategoryIdAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
The category name. |
Returns
| Type | Description |
|---|---|
| Task<>long |
Id of the category entity. |
GetSettingAsync(string, string, IEntityLoadConfiguration)
Gets the setting with the specified name from the specified category.
If the category or setting could not be found, null is returned.
Declaration
RequestResponse
Task<IEntity> GetSettingAsync(string category, string name, IEntityLoadConfiguration loadConfiguration = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | category |
The category to get the setting from. |
| string | name |
The name of the setting to get. |
| IEntityLoadConfiguration | loadConfiguration |
Load configuration. |
Returns
| Type | Description |
|---|---|
| Task<>IEntity |
The setting with the specified name from the specified category or null if that setting doesn't exist. |
GetSettingsForCategoryAsync(string, IEntityLoadConfiguration)
Gets the settings for the specified category.
Declaration
RequestResponse
Task<IList<IEntity>> GetSettingsForCategoryAsync(string category, IEntityLoadConfiguration loadConfiguration = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | category |
The category to get the setting for. |
| IEntityLoadConfiguration | loadConfiguration |
Load configuration. |
Returns
| Type | Description |
|---|---|
| Task<>IList<>IEntity |
A list of all setting entities for the specified category. |
Exceptions
| Type | Condition |
|---|---|
| NotFoundException |
Unable to find the category with the specified name. |