Interface IConvertUserKey

Interface for converting the userKey object in a membership provider into a string.

Namespace: Mediachase.Commerce.Customers
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
[Obsolete("Re-implement as IUserKeyConverter to specify what type the converter is valid for instead of registering a named instance in the ServiceLocator. Will remain at least until June 2016.")]
public interface IConvertUserKey
Remarks

The userKey is typed as an object without any other requirements, which means there is no generic way to perform a userKey-to-string conversion. Rather we have to create distinct implementations for each type of userKey that we need to support.

Methods

ConvertToString(Object)

Converts the user key to a string.

Declaration
string ConvertToString(object userKey)
Parameters
Type Name Description
System.Object userKey

The provider user key.

Returns
Type Description
System.String

A string representation of the user key.

ConvertToUserKey(String)

Converts a string to a provider user key.

Declaration
object ConvertToUserKey(string key)
Parameters
Type Name Description
System.String key

The provider user key.

Returns
Type Description
System.Object

The provider user key.