Table of Contents

Interface IConsentAgreementService

Namespace
CMS.DataProtection
Assembly
CMS.DataProtection.dll

Service to manage consent agreements.

public interface IConsentAgreementService
Extension Methods

Methods

Agree(ContactInfo, ConsentInfo)

Inserts an agreement of the given consent and the given contact.

ConsentAgreementInfo Agree(ContactInfo contact, ConsentInfo consent)

Parameters

contact ContactInfo

Contact

consent ConsentInfo

Consent

Returns

ConsentAgreementInfo

Returns the agreement.

Remarks

If an active agreement already exists then this active agreement is kept and its hash is updated with a one from the given consent.

Exceptions

ArgumentNullException

contact is null -or consent is null

GetAgreedConsents(ContactInfo)

Returns agreed consents for the given contact.

IEnumerable<Consent> GetAgreedConsents(ContactInfo contact)

Parameters

contact ContactInfo

Contact.

Returns

IEnumerable<Consent>

Remarks

Only returns agreed consents, revoked consents are not included.

Exceptions

ArgumentNullException

Thrown when contact is null.

IsAgreed(ContactInfo, ConsentInfo)

Indicates whether the given contact has agreed with the specified consent.

bool IsAgreed(ContactInfo contact, ConsentInfo consent)

Parameters

contact ContactInfo

Contact.

consent ConsentInfo

Consent.

Returns

bool

Returns true when the given contact agreed with the specified consent and is still valid.

Exceptions

ArgumentNullException

contact is null -or consent is null

Revoke(ContactInfo, ConsentInfo)

Revokes an agreement of the given consent for the given contact.

ConsentAgreementInfo Revoke(ContactInfo contact, ConsentInfo consent)

Parameters

contact ContactInfo

Contact

consent ConsentInfo

Consent

Returns

ConsentAgreementInfo

Returns the agreement object that has been revoked.

Exceptions

ArgumentNullException

contact is null -or consent is null