Class ConsentService

Namespace

Dynamicweb.DataProcessing

Assembly

Dynamicweb.Core.dll

Service for handling Consents.

public class ConsentService

Inheritance

object

ConsentService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

DeleteConsent(string, string, string)

Deletes the consent.

public virtual void DeleteConsent(string activityId, string subjectId, string subjectType)

Parameters

activityId string

The activity identifier.

subjectId string

The subject identifier.

subjectType string

Type of the subject.

GetConsentById(string, string, string)

Gets a consent by identifier.

public virtual Consent GetConsentById(string activityId, string subjectId, string subjectType)

Parameters

activityId string

The activity identifier.

subjectId string

The subject identifier.

subjectType string

Type of the subject.

Returns

Consent

An instance of Consent.

GetConsents()

Gets all consents.

public virtual IEnumerable<Consent> GetConsents()

Returns

IEnumerable<Consent>

A collection of consents.

GetConsentsByActivity(string)

Gets all consents to a given activity.

public virtual IEnumerable<Consent> GetConsentsByActivity(string activityId)

Parameters

activityId string

The activity identifier.

Returns

IEnumerable<Consent>

A collection of consents.

GetConsentsByPage(string, int, int, string)

Gets consents by search.

public virtual IEnumerable<Consent> GetConsentsByPage(string searchText, int pageNumber, int pageSize, string orderBy)

Parameters

searchText string

The search text.

pageNumber int

The page number.

pageSize int

Size of the page.

orderBy string

The order by.

Returns

IEnumerable<Consent>

A collection of consents matching the search text.

GetConsentsBySubject(string, string)

Gets all consents by a given subject.

public virtual IEnumerable<Consent> GetConsentsBySubject(string subjectId, string subjectType)

Parameters

subjectId string

The subject identifier.

subjectType string

Type of the subject.

Returns

IEnumerable<Consent>

A collection of consents.

GetFoundConsentsCount(string)

Gets the number of consents matching a given search text.

public virtual int GetFoundConsentsCount(string searchText)

Parameters

searchText string

The search text.

Returns

int

A number of consents matching the search text.

GiveConsent(string, string, string, ConsentRequestInfo)

Gives consent to an activity by a subject.

public virtual Consent GiveConsent(string activityId, string subjectId, string subjectType, ConsentRequestInfo requestInfo)

Parameters

activityId string

The activity identifier.

subjectId string

The subject identifier.

subjectType string

Type of the subject.

requestInfo ConsentRequestInfo

The request information.

Returns

Consent

An instance of Consent.

WithdrawConsent(string, string, string, ConsentRequestInfo)

Withdraws a consent to an activity by a subject.

public virtual Consent WithdrawConsent(string activityId, string subjectId, string subjectType, ConsentRequestInfo requestInfo)

Parameters

activityId string

The activity identifier.

subjectId string

The subject identifier.

subjectType string

Type of the subject.

requestInfo ConsentRequestInfo

The request information.

Returns

Consent