Interface ISettingsDetailDataProvider

Namespace

Kentico.Xperience.Admin.Base.UIPages

Assembly

Kentico.Xperience.Admin.Base.dll

Describes data provider for client page used for editing settings keys.

[Obsolete("The interface was not meant to be public. This interface will be removed in future releases.")]
[ObsoleteSince(28, 0)]
public interface ISettingsDetailDataProvider

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

GetParentCategoryName(int)

Returns localized name of the category specified by given categoryId.

Task<string> GetParentCategoryName(int categoryId)

Parameters

categoryId int

Category ID

Returns

Task<string>

GetSettings(int, string)

Returns settings categories with assigned keys based on given parameters.

Task<List<SettingsGroupCategory>> GetSettings(int categoryId, string filter = null)

Parameters

categoryId int

ID of selected category

filter string

Search filter expression

Returns

Task<List<SettingsGroupCategory>>

SaveSettings(IEnumerable<IFormComponent>)

Updates settings keys based on component values returned from the client page.

void SaveSettings(IEnumerable<IFormComponent> components)

Parameters

components IEnumerable<IFormComponent>

Form components with updated values