View Source

Interface IConsent

Represents a consent state.

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public interface IConsent : IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Remarks

A consent is fully identified by a source (whoever is consenting), a context (for example, an application), and an action (whatever is consented).

A consent state registers the state of the consent (granted, revoked...).

Properties

Action

Gets the unique identifier of the consented action.

Declaration

string Action { get; }

Property Value

Type	Description
System.String

Comment

Gets some additional free text.

Declaration

string Comment { get; }

Property Value

Type	Description
System.String

Context

Gets the unique identifier of the context of the consent.

Declaration

string Context { get; }

Property Value

Type	Description
System.String

Remarks

Represents the domain, application, scope... of the action.

When the action is a Udi, this should be the Udi type.

Current

Determines whether the consent entity represents the current state.

Declaration

bool Current { get; }

Property Value

Type	Description
System.Boolean

History

Gets the previous states of this consent.

Declaration

IEnumerable<IConsent>? History { get; }

Property Value

Type	Description
System.Nullable<IEnumerable<IConsent>>

Source

Gets the unique identifier of whoever is consenting.

Declaration

string Source { get; }

Property Value

Type	Description
System.String

State

Gets the state of the consent.

Declaration

ConsentState State { get; }

Property Value

Type	Description
ConsentState