Interface ISettingsClient

Client for fetching setting and category entities.

Namespace: StylelabsStylelabs.MSdkClients

public interface ISettingsClient

Gets the id of a category by name.

Task<long?> GetCategoryIdAsync(string name)

Type	Name	Description
string	name	The category name.

Type	Description
Task<>long	Id of the category entity.

Gets the setting with the specified name from the specified category. If the category or setting could not be found, null is returned.

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

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.

Type	Description
Task<>IEntity	The setting with the specified name from the specified category or null if that setting doesn't exist.

Gets the settings for the specified category.

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

Type	Name	Description
string	category	The category to get the setting for.
IEntityLoadConfiguration	loadConfiguration	Load configuration.

Type	Description
Task<>IList<>IEntity	A list of all setting entities for the specified category.

Type	Condition
NotFoundException	Unable to find the category with the specified name.

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