Class ConsentService
- Namespace
- Dynamicweb.DataProcessing
- Assembly
- Dynamicweb.DataProcessing.dll
Service for handling consents.
public class ConsentService
- Inheritance
-
ConsentService
- Inherited Members
Constructors
ConsentService()
Initializes a new instance of the ConsentService class.
public ConsentService()
- See Also
Methods
DeleteConsent(string, string, string)
Deletes the consent.
public 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.
- See Also
GetConsentById(string, string, string)
Gets a consent by identifier.
public 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
- See Also
GetConsents()
Gets all consents.
public IEnumerable<Consent> GetConsents()
Returns
- IEnumerable<Consent>
- A collection of consents.
- See Also
GetConsentsByActivity(string)
Gets all consents to a given activity.
public IEnumerable<Consent> GetConsentsByActivity(string activityId)
Parameters
activityId
string- The activity identifier.
Returns
- IEnumerable<Consent>
- A collection of consents.
- See Also
GetConsentsByPage(string, int, int, string)
Gets consents by search.
public 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.
- See Also
GetConsentsBySubject(string, string)
Gets all consents by a given subject.
public IEnumerable<Consent> GetConsentsBySubject(string subjectId, string subjectType)
Parameters
Returns
- IEnumerable<Consent>
- A collection of consents.
- See Also
GetFoundConsentsCount(string)
Gets the number of consents matching a given search text.
public int GetFoundConsentsCount(string searchText)
Parameters
searchText
string- The search text.
Returns
- int
- A number of consents matching the search text.
- See Also
GiveConsent(string, string, string, ConsentRequestInfo)
Gives consent to an activity by a subject.
public 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
- See Also
WithdrawConsent(string, string, string, ConsentRequestInfo)
Withdraws a consent to an activity by a subject.
public 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
- See Also