Interface IFormConsentAgreementService

Namespace

CMS.DataProtection

Assembly

CMS.DataProtection.dll

Service to agree consent in forms.

public interface IFormConsentAgreementService

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Agree(ContactInfo, ConsentInfo, BaseInfo)

Agrees the given consent with the given contact.

ConsentAgreementInfo Agree(ContactInfo contact, ConsentInfo consent, BaseInfo data)

Parameters

contact ContactInfo

Contact.

consent ConsentInfo

Consent.

data BaseInfo

Info object being edited by the form.

Returns

ConsentAgreementInfo

The agreement.

Remarks

When contact is null, ensures contact and maps data to a contact based on mapping configuration of an object.

Exceptions

ArgumentNullException

Thrown when consent or data is null.

Revoke(ContactInfo, ConsentInfo, BaseInfo)

Revokes the given consent for the given contact.

ConsentAgreementInfo Revoke(ContactInfo contact, ConsentInfo consent, BaseInfo data)

Parameters

contact ContactInfo

Contact.

consent ConsentInfo

Consent.

data BaseInfo

Info object being edited by the form.

Returns

ConsentAgreementInfo

The revoked agreement.

Remarks

When contact is null, ensures contact and maps data to a contact based on mapping configuration of an object.

Exceptions

ArgumentNullException

Thrown when consent or data is null.