SaaS CMS has officially launched! Learn more now.

Interface IUserKeyConverter

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

Namespace: Mediachase.Commerce.Customers
Assembly: Mediachase.Commerce.dll
Version: 11.8.3
Syntax
public interface IUserKeyConverter
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.

Properties

ForType

Gets the type the implementation can convert.

Declaration
Type ForType { get; }
Property Value
Type Description
System.Type

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.