Virtual Happy Hour this month, Jun 28, we'll be getting a sneak preview at our soon to launch SaaS CMS!

Try our conversational search powered by Generative AI!

Interface IUserSettings

Implemented by security settings plug-ins

Namespace: EPiServer.PlugIn
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
public interface IUserSettings

Properties

SaveRequiresUIReload

Gets or sets a value indicating whether caller needs to do a reload on UI/Page.

Declaration
bool SaveRequiresUIReload { get; set; }
Property Value
Type Description
System.Boolean

true if a UI reload is required; otherwise, false.

Remarks

This can be used to tell to caller that we have done something in a plugin that requires a reload on page.

Methods

LoadSettings(String, EPiServerProfile)

Called to let a plugin populate its fields from either the personalized data provided or any external source.

Declaration
void LoadSettings(string userName, EPiServerProfile data)
Parameters
Type Name Description
System.String userName

Name of user.

EPiServerProfile data

The profile for the given user.

Remarks

Assumes that information is read from data.

SaveSettings(String, EPiServerProfile)

Called to let a plugin save its data as entered by the user to either the provided personalized information or to any external data source.

Declaration
void SaveSettings(string userName, EPiServerProfile data)
Parameters
Type Name Description
System.String userName

Name of the user.

EPiServerProfile data

The profile for the given user.

Remarks

It is allowed (and expected) that the implementation writes information back to data.

Extension Methods