Authentication.MfaProviderSiteSettings Class
Namespace: Nucleus.Abstractions.Authentication
Assembly: Nucleus.Abstractions.dll
Base class provider settings for user settings ( move to abstract?)
Properties
Enabled Property
Gets or sets whether this MFA provider is enabled for the site.
Enforced Property
Gets or sets whether this MFA provider is enforced for the site. If true, users will be required to configure this MFA provider before they can log in.
ProviderName Property
Returns a unique name for the MFA provider, which is used as part of the key for provider settings.
Methods
GetSettings (Site) Method
GetSettings (Site site)
Populate this object's property using values from site settings.
Parameters
| Name | Type |
|---|---|
| site | Nucleus.Abstractions.Models.Site |
SetSettings (Site) Method
SetSettings (Site site)
Updates the specified site's settings with values from this object's properties.
Parameters
| Name | Type |
|---|---|
| site |
Nucleus.Abstractions.Models.Site
The site whose settings will be updated. This parameter must not be null. |
TryGetValue (List<SiteSetting>, String, Boolean) Method
TryGetValue (List<SiteSetting> settings, String key, Boolean result)
Gets the specified value or returns an empty string if the key is not present.
Parameters
| Name | Type |
|---|---|
| settings | System.Collections.Generic.List<Nucleus.Abstractions.Models.SiteSetting> |
| key | String |
| result | ref Boolean |
Remarks
We need a private implementation of this function because the Abstractions project cannot reference Nucleus.Extensions as it would be a circular reference.
TrySetValue (List<SiteSetting>, String, Nullable<Boolean>) Method
TrySetValue (List<SiteSetting> settings, String key, Nullable<Boolean> value)
Adds or replaces the value for the specified key.
Parameters
| Name | Type |
|---|---|
| settings | System.Collections.Generic.List<Nucleus.Abstractions.Models.SiteSetting> |
| key | String |
| value | System.Nullable<System.Boolean> |
Remarks
We need a private implementation of this function because the Abstractions project cannot reference Nucleus.Extensions as it would be a circular reference.