Struct ContentAccessSettings

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Represents access control settings for content items. Encapsulates both security state and required member roles with built-in validation.

public struct ContentAccessSettings

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

IsSecured

Gets a value indicating whether the content item is secured and requires authentication.

public readonly bool IsSecured { get; }

Property Value

bool

RequiredMemberRoleIDs

Gets the collection of member role IDs that have access to the content item. An empty collection means all authenticated users have access (when IsSecured is true).

public IReadOnlyCollection<int> RequiredMemberRoleIDs { get; }

Property Value

IReadOnlyCollection<int>

Methods

Equals(ContentAccessSettings)

public bool Equals(ContentAccessSettings other)

Parameters

other ContentAccessSettings

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Public()

Creates content access settings for public (unsecured) content. No authentication required.

public static ContentAccessSettings Public()

Returns

ContentAccessSettings

A ContentAccessSettings instance configured for public access.

Secured()

Creates content access settings for secured content accessible by all authenticated users. Requires authentication but no specific roles.

public static ContentAccessSettings Secured()

Returns

ContentAccessSettings

A ContentAccessSettings instance configured for authenticated access.

SecuredWithRoles(IEnumerable<int>)

Creates content access settings for secured content restricted to specific member roles.

public static ContentAccessSettings SecuredWithRoles(IEnumerable<int> requiredMemberRoleIDs)

Parameters

requiredMemberRoleIDs IEnumerable<int>

Collection of member role IDs that have access.

Returns

ContentAccessSettings

A ContentAccessSettings instance configured for role-based access.

Exceptions

ArgumentNullException

Thrown when requiredMemberRoleIDs is null.

ArgumentException

Thrown when requiredMemberRoleIDs is empty.