Class CurrentContactProviderContextDecorator

Namespace

CMS.ContactManagement

Assembly

CMS.ContactManagement.dll

Decorates the implementation of ICurrentContactProvider given in constructor to perform CMS.ContactManagement.Internal.IContactProcessingChecker.CanProcessContactInCurrentContext(bool) check before invoking every method.

[Obsolete("Class was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(29, 0)]
public class CurrentContactProviderContextDecorator : ICurrentContactProvider

Inheritance

object

CurrentContactProviderContextDecorator

Implements

ICurrentContactProvider

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

CurrentContactProviderContextDecorator(ICurrentContactProvider, IContactProcessingChecker)

Instantiates new instance of CurrentContactProviderContextDecorator.

public CurrentContactProviderContextDecorator(ICurrentContactProvider defaultCurrentContactProvider, IContactProcessingChecker contactProcessingChecker)

Parameters

defaultCurrentContactProvider ICurrentContactProvider

Implementation of ICurrentContactProvider to be decorated

contactProcessingChecker IContactProcessingChecker

Provides method for checking whether the contact processing can continue

Methods

GetCurrentContact()

Checks whether processing of contact can continue. If so, recognizes a contact currently browsing the live site. If the contact cannot be recognized a new one is created. A returned contact is always valid (exists in database, is not merged, etc.).

public ContactInfo GetCurrentContact()

Returns

ContactInfo

The recognized contact or a new contact, if it was not possible to recognize the contact.

Exceptions

InvalidOperationException

Processing of contacts cannot continue. This can be due to the insufficient license, disabled online marketing or incorrect request state.

GetExistingContact()

Checks whether processing of contact can continue. If so, gets a contact assigned to the visitor currently browsing the live site (contact can only be recognized during web request). A returned contact is always valid (exists in database, is not merged, etc.). If no contact is currently assigned to the visitor null is returned.

public ContactInfo GetExistingContact()

Returns

ContactInfo

The recognized contact or null when there is no contact assigned to current live site visitor

Exceptions

InvalidOperationException

Processing of contacts cannot continue. This can be due to the insufficient license, disabled online marketing or incorrect request state.

SetCurrentContact(ContactInfo)

Checks whether processing of contact can continue. If so, stores information about the current contact into the persistent storage (IContactPersistentStorage), so that the next time (possibly in another request in the same session) GetCurrentContact() is called, the stored contact is returned.

public void SetCurrentContact(ContactInfo contact)

Parameters

contact ContactInfo

The contact who performed the request

Exceptions

InvalidOperationException

Processing of contacts cannot continue. This can be due to the insufficient license, disabled online marketing or incorrect request state.