Try our conversational search powered by Generative AI!

AI OnAI Off

Class ProviderCapabilities

A class to see if provider has support for ProviderActions actions.

Inheritance
System.Object
ProviderCapabilities
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Security
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
public static class ProviderCapabilities
Remarks

SqlServerMembershipProvider, SqlServerRoleProvider and ActiveDirectoryMembershipProvider are added with default values. WindowsMembershipProvider, WindowsRoleProvider and ActiveDirectoryRoleProvider are also added if among the configured providers in confic, with values extracted from their ProviderCapabilityAttribute settings. Enables you to check if a provider has support for different action in code.

Properties

HasConfiguredMembershipProviders

Returns true when there are more than one working membership provider configured

Declaration
public static bool HasConfiguredMembershipProviders { get; }
Property Value
Type Description
System.Boolean

Providers

Generic Dictionary with role and member providers

Declaration
public static IDictionary<Type, ProviderCapabilitySettings> Providers { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Type, ProviderCapabilitySettings>

Methods

AddProvider(Type, ProviderCapabilitySettings)

Adds capabilities for a custom provider. Alternatively, decorate the custom provider with the ProviderCapabilityAttribute

Declaration
public static void AddProvider(Type providerType, ProviderCapabilitySettings settings)
Parameters
Type Name Description
System.Type providerType

The type of the provider.
ProviderCapabilitySettings settings

The provider capabilities settings.

IsSupported(String, ProviderActions)

Determines whether a provider supports a specific ProviderActions.

Declaration
public static bool IsSupported(string providerName, ProviderActions action)
Parameters
Type Name Description
System.String providerName

Name on provider.
ProviderActions action

Action on provider ProviderActions
Returns
Type Description
System.Boolean

Returns true if action on provider is supported otherwise false.

IsSupported(String, String)

Determines whether the specified provider has support for the property been sent in.

Declaration
public static bool IsSupported(string providerName, string propertyName)
Parameters
Type Name Description
System.String providerName

Name of the provider.
System.String propertyName

Name of the property.
Returns
Type Description
System.Boolean
Remarks

Default we have 2 properties defined email and comment.