Link Search Menu Expand Document

CacheItem


This class is used as an item for the ICache object.

Methods

Please see the IExpirable methods.

Properties

  • Key - the key to the cache.
  • Value - the value of the class (a generic type).
  • CacheItemExpiration - the expiration of the cache in minutes.

In addition, please see the IExpirable properties.

Creating New Instance

Below is the way on how to create a new instance of this class.

var expirationInMinutes = 180;
var item = new CacheItem("Key", "Value", expirationInMinutes);

Passing to the Cache

Usually, the ICache object is embedded within the repository. Let us say you have a repository named PersonRepository.

The code below is an explicit call to add a cache in a manual manner.

var people = GetPeople();
var expirationInMinutes = 180;
var item = new CacheItem<IEnumerable<Person>>("CacheKey:ActivePeople", people, expirationInMinutes);

using (var repository = new PersonRepository())
{
    repository.Cache.Add(item);
}

Usually, the cache will automatically be set by passing a value to the cacheKey argument when calling the Query or BatchQuery operations.

Retrieving from the Cache

To retrieve an item from the cache, directly access the ICache object and call the Get() method passing the key.

Let us say, the repository PersonRepository is existing.

var item = repository.Cache.Get<IEnumerable<Person>>("CacheKey:ActivePeople");

If the cache is not found on the given key, by default it will throw an exception. You can set the throwException argument to false if you wish not to throw an exception.