Class CapabilityService

Namespace

Dynamicweb.CoreUI.CapabilityControl

Assembly

Dynamicweb.CoreUI.dll

public abstract class CapabilityService : ICacheStorage<int, HashSet<CapabilityAccess>>, ICacheStorage<int>, ICacheStorage

Inheritance

object

CapabilityService

Implements

ICacheStorage<int, HashSet<CapabilityAccess>>

ICacheStorage<int>

ICacheStorage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Info

Represents the Cache information

public abstract CacheInformation Info { get; }

Property Value

CacheInformation

Methods

ClearCache()

Clears Cache

public abstract void ClearCache()

ClearCache(IEnumerable<int>)

Clears Cache by user group ids collection

public abstract void ClearCache(IEnumerable<int> keys)

Parameters

keys IEnumerable<int>

The collection of user group ids

ClearCache(int)

Clears Cache by user group id

public abstract void ClearCache(int key)

Parameters

key int

The user group id

CurrentUserHasCapabilities(IEnumerable<CapabilityKey>)

Checks whether the current user has access to use the specified collection of capabilities.

public abstract bool CurrentUserHasCapabilities(IEnumerable<CapabilityKey> capabilityKeys)

Parameters

capabilityKeys IEnumerable<CapabilityKey>

Capability keys

Returns

bool

CurrentUserHasCapability(CapabilityKey)

Checks whether the current user has access to use the specified capability.

public abstract bool CurrentUserHasCapability(CapabilityKey capabilityKey)

Parameters

capabilityKey CapabilityKey

The capability key

Returns

bool

GetCapabilityAccess(int, CapabilityKey)

Gets capability access data

public abstract CapabilityAccess? GetCapabilityAccess(int userGroupId, CapabilityKey key)

Parameters

userGroupId int

User group id

key CapabilityKey

Capability key

Returns

CapabilityAccess

GetCapabilityAccesses(IEnumerable<CapabilityKey>)

Gets all capability access data for specified capability keys

public abstract HashSet<CapabilityAccess> GetCapabilityAccesses(IEnumerable<CapabilityKey> keys)

Parameters

keys IEnumerable<CapabilityKey>

Capability keys

Returns

HashSet<CapabilityAccess>

RestrictCapability(int, Capability)

Restricts access to capability.

public abstract void RestrictCapability(int userGroupId, Capability capability)

Parameters

userGroupId int

User group id

capability Capability

Capability

SetCacheType<TObjectCache>()

Sets the Cache type

public abstract void SetCacheType<TObjectCache>() where TObjectCache : ServiceCache<int, HashSet<CapabilityAccess>>

Type Parameters

TObjectCache

UnrestrictCapability(int, Capability)

Remove access restriction for capability.

public abstract void UnrestrictCapability(int userGroupId, Capability capability)

Parameters

userGroupId int

User group id

capability Capability

Capability

UserHasCapabilities(int, IEnumerable<CapabilityKey>)

Checks whether the user has access to use the specified collection of capabilities.

public abstract bool UserHasCapabilities(int userId, IEnumerable<CapabilityKey> capabilityKeys)

Parameters

userId int

User id

capabilityKeys IEnumerable<CapabilityKey>

Capability keys

Returns

bool

UserHasCapability(int, CapabilityKey)

Checks whether the user has access to use the specified capability.

public abstract bool UserHasCapability(int userId, CapabilityKey capabilityKey)

Parameters

userId int

User id

capabilityKey CapabilityKey

The capability key

Returns

bool