Interface ISettingsClient
Client for fetching setting and category entities.
Namespace: Stylelabs.M.Sdk.Clients
Assembly: Stylelabs.M.Sdk.dll
Syntax
public interface ISettingsClientMethods
GetCategoryIdAsync(String)
Gets the id of a category by name.
Declaration
Task<long?> GetCategoryIdAsync(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Returns
| Type | Description |
|---|---|
| Task<System.Nullable<System.Int64>> | 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
Task<IEntity> GetSettingAsync(string category, string name, IEntityLoadConfiguration loadConfiguration = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | category | The category to get the setting from. |
| System.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
Task<IList<IEntity>> GetSettingsForCategoryAsync(string category, IEntityLoadConfiguration loadConfiguration = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.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. |
Can we improve this article ? Provide feedback