Class CMSCacheDependency

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

Establishes a dependency relationship between an item stored in ASP.NET application's cache and a file, cache key, an array of either or another dependency object. This class monitors the dependency relationship so that when any of them changes, the cache item will be automatically removed.

public class CMSCacheDependency

Inheritance

object

CMSCacheDependency

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

CMSCacheDependency()

Initializes a new instance of the CMSCacheDependency class that monitors a file or directory for change.

public CMSCacheDependency()

CMSCacheDependency(string[], string[])

Initializes a new instance of the CMSCacheDependency class that monitors a file or directory for change.

public CMSCacheDependency(string[] filenames, string[] cachekeys)

Parameters

filenames string[]

Sets FileNames collection.

cachekeys string[]

Sets CacheKeys collection.

CMSCacheDependency(string[], string[], DateTime)

Initializes a new instance of the CMSCacheDependency class that monitors a file or directory for change.

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(29, 6)]
public CMSCacheDependency(string[] filenames, string[] cachekeys, DateTime start)

Parameters

filenames string[]

Sets FileNames collection.

cachekeys string[]

Sets CacheKeys collection.

start DateTime

Sets Start date time against which to check the last modified date of the objects passed in the file names and cache key arrays.

Properties

CacheKeys

Gets the cache keys of the dependency.

public string[] CacheKeys { get; set; }

Property Value

string[]

FileNames

Collection of file full paths used for cache dependency.

public string[] FileNames { get; set; }

Property Value

string[]

Remarks

Paths pointing to the external storage are ignored and not used for cache dependency.

IncludeDefaultDependencies

Indicates whether the dependency should include also default dependencies.

[Obsolete("Property is deprecated and will be removed in the next version.")]
[ObsoleteSince(29, 6)]
public bool IncludeDefaultDependencies { get; set; }

Property Value

bool

Start

The date and time against which to check the last modified date of the objects passed in the filenames and cache keys arrays

[Obsolete("Property is deprecated and will be removed in the next version.")]
[ObsoleteSince(29, 6)]
public DateTime Start { get; set; }

Property Value

DateTime

Methods

EnsureDummyKeys()

Ensures the dummy keys for this dependency

[Obsolete("Method is deprecated and will be removed in the next version.")]
[ObsoleteSince(29, 6)]
public void EnsureDummyKeys()